Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save jcramirez/8e37609ca37fa9fd9126ca534d0aa663 to your computer and use it in GitHub Desktop.
Save jcramirez/8e37609ca37fa9fd9126ca534d0aa663 to your computer and use it in GitHub Desktop.
# Project Title
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
A nice project with a nice description
---
## Requirements
For development, you will only need Node.js and a node global package, installed in your environment.
### 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
vx.x.x
$ npm --version
x.x.x
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
---
## Install
$ git clone https://github.com/YOUR_USERNAME/PROJECT_TITLE
$ cd PROJECT_TITLE
$ npm 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
$ npm start
## Simple build for production
$ npm build
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment