Skip to content

Commit d39597f

Browse files
committed
few updates
1 parent fa30537 commit d39597f

File tree

5 files changed

+8
-1
lines changed

5 files changed

+8
-1
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ NodeJS is far too powerful to be limited to just running your website. Whether b
77
- Building a worker scripts.
88
- Stand-alone scripting and automation tool.
99
- Fully customizable project.
10+
- Forcing you to write clean-easy-to-read code.
1011
- Clean file structuring.
1112
- Following standard naming conventions so collaborators/team8s can understand easily your code.
1213
- Securing your login and api key details by using environment variable -- [dotenv](https://github.com/motdotla/dotenv)
@@ -30,6 +31,11 @@ NodeJS is far too powerful to be limited to just running your website. Whether b
3031
6. Modify the package.json file. Edit the project name and other stuff.
3132
7. Finally, start and build your application scripts. Customize your project however you like.
3233
34+
### Recommendation
35+
Try to add your script and other stuff inside /core folder.
36+
If you want to run specific script inside the ./core folder, try to set it in package.json script.
37+
For example, when you try to run ```./core/hello-world.js```, instead of ```cd core && node hello-world```, you can use a command that was set in package.json file ```npm run hello-world```.
38+
3339
### 📘 Why is it important to use env file?
3440
It has variety of usage. Find out [more](https://codeburst.io/process-env-what-it-is-and-why-when-how-to-use-it-effectively-505d0b2831e7).
3541
But the sole purpose of using .env file for our project is to secure our credentials such as logins, api keys, and other important stuff. It is important not to include your .env file when you in our repository specially when your project is public.

package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
"main": "app.js",
66
"scripts": {
77
"test": "echo \"Error: no test specified\" && exit 1",
8-
"start": "node app.js"
8+
"start": "node app.js",
9+
"hello-world": "node core/hello-world.js"
910
},
1011
"keywords": [
1112
"NodeJs Boilerplate",

0 commit comments

Comments
 (0)