@@ -3,9 +3,10 @@ Clean and minimalistic boilerplate to start your NodeJs project.
33
44### ⭐ Good for
55 - Building a worker scripts.
6- - Scraper and parser tool.
6+ - Building scripting and automation tool.
77 - Stand-alone, fully customizable project.
88 - Creating clean file structured project.
9+ - Following standard naming conventions so collaborators/team8s can understand easily your code.
910
1011### 📘 Prerequisites
1112 - NodeJs Installed in your local environment.
@@ -14,17 +15,15 @@ Clean and minimalistic boilerplate to start your NodeJs project.
1415### 📝 Usage
15161 . Clone the repo to your local environment.
1617 - On the command prompt run the following commands:
17- ```
18- $ git clone https://github.com/yortrosal/nodejs-boilerplate.git
19- $ cd nodejs-boilerplate
20- ```
21- 2 . ``` npm install ``` to install initial dependencies.
18+ run ``` git clone https://github.com/yortrosal/nodejs-boilerplate.git ```
19+ then ``` cd nodejs-boilerplate ```
20+ 2 . run ``` npm install ``` to install initial dependencies.
22213 . Make sure you have .env file available.
2322 Or generate one: ``` cp .env.example .env ``` (edit it with your secret keys and other credentials)
24234 . Once you have the .env file setup in the main directory.
25245 . run ▶️ ``` npm start ``` to start the program. It will run the script from the app.js file.
26256 . Modify the package.json file. Edit the project name and other stuff.
27- 7 . Finally, start and build your application scripts.
26+ 7 . Finally, start and build your application scripts. Customize your project however you like.
2827
2928### 📘 Why is it important to use env file?
3029It has variety of usage. Find out [ more] ( https://codeburst.io/process-env-what-it-is-and-why-when-how-to-use-it-effectively-505d0b2831e7 ) .
0 commit comments