Skip to content

Search… All gists Back to GitHub @Pegasus2002 @Igormandello Igormandello/Node.js project readme template Last active last year • Report abuse 5 Code Revisions 5 Stars 21 Forks 5

Node.js project readme template

A nice project with a nice description

For development, you will only need Node.js and a node global package, Yarn, installed in your environement.

• Node installation on Windows

  Just go on official Node.js website and download the installer. Also, be sure to have git available in your PATH, npm might need it (You can find git here).

• 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 and the official NPM website.

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

After installing node, this project will need yarn too, so just run the following command.

  $ npm install -g yarn

$ git clone https://github.com/YOUR_USERNAME/PROJECT_TITLE
$ cd PROJECT_TITLE
$ yarn install

Open a/nice/path/to/a.file then edit it with your settings. You will need:

• A setting;
• Another setting;
• One more setting;

$ yarn start

$ yarn build

@decadeofdata decadeofdata commented on Sep 20, 2020 Can I make a pull request to fix the spelling?

@Pegasus2002

Add heading textAdd bold text, <Ctrl+b>Add italic text, <Ctrl+i> Add a quote, <Ctrl+Shift+.>Add code, <Ctrl+e>Add a link, <Ctrl+k> Add a bulleted list, <Ctrl+Shift+8>Add a numbered list, <Ctrl+Shift+7>Add a task list, <Ctrl+Shift+l> Directly mention a user or team Reference an issue or pull request Leave a comment No file chosen Attach files by dragging & dropping, selecting or pasting them. Styling with Markdown is supported Footer © 2023 GitHub, Inc. Footer navigation Terms Privacy Security Status Docs Contact GitHub Pricing API Training Blog About