Skip to content

Instantly share code, notes, and snippets.

@Igormandello
Last active December 19, 2023 08:23
Show Gist options
  • Save Igormandello/57d57ee9a9f32a5414009cbe191db432 to your computer and use it in GitHub Desktop.
Save Igormandello/57d57ee9a9f32a5414009cbe191db432 to your computer and use it in GitHub Desktop.
# Project Title
A nice project with a nice description
---
## Requirements
For development, you will only need Node.js and a node global package, Yarn, installed in your environement.
### Node
- #### Node installation on Windows
Just go on [official Node.js website](https://nodejs.org/) and download the installer.
Also, be sure to have `git` available in your PATH, `npm` might need it (You can find git [here](https://git-scm.com/)).
- #### Node installation on Ubuntu
You can install nodejs and npm easily with apt install, just run the following commands.
$ sudo apt install nodejs
$ sudo apt install npm
- #### Other Operating Systems
You can find more information about the installation on the [official Node.js website](https://nodejs.org/) and the [official NPM website](https://npmjs.org/).
If the installation was successful, you should be able to run the following command.
$ node --version
v8.11.3
$ npm --version
6.1.0
If you need to update `npm`, you can make it using `npm`! Cool right? After running the following command, just open again the command line and be happy.
$ npm install npm -g
###
### Yarn installation
After installing node, this project will need yarn too, so just run the following command.
$ npm install -g yarn
---
## Install
$ git clone https://github.com/YOUR_USERNAME/PROJECT_TITLE
$ cd PROJECT_TITLE
$ yarn install
## Configure app
Open `a/nice/path/to/a.file` then edit it with your settings. You will need:
- A setting;
- Another setting;
- One more setting;
## Running the project
$ yarn start
## Simple build for production
$ yarn build
@decadeofdata
Copy link

Can I make a pull request to fix the spelling?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment