Skip to content

Commit 93395e8

Browse files
committed
local-mac: few readme and config updates
1 parent e4902bb commit 93395e8

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# A NodeJs Project Kickstarter Biolerplate
22
Clean, minimalistic boilerplate to start your NodeJs project.
33

4-
NodeJS is far too powerful to be limited to just running your website. Whether building a website, comminicating with the database or writing a script to automate a file process, you can't go wrong with NodeJS.
4+
NodeJS is far too powerful to be limited to just running your website. Whether building a website, communicating with the database or writing a script to automate a file process, you can't go wrong with NodeJS.
55

66
### ⭐ Good for
77
- Building a worker scripts.
@@ -52,7 +52,7 @@ But the sole purpose of using .env file for our project is to secure our credent
5252
│ └── hello-world.js
5353
5454
├── .env.example
55-
├── .env
55+
├── .env // store all your credentials here
5656
├── .plans
5757
├── .gitignore
5858
├── app.js
@@ -62,6 +62,9 @@ But the sole purpose of using .env file for our project is to secure our credent
6262
### Initial Dependency
6363
- [ckey](https://www.npmjs.com/package/ckey) - a [dotenv](https://github.com/motdotla/dotenv) helper for accessing process.env object from sub-directory.
6464
65+
### Storing Credentials in .env file
66+
- This is where you put your login credentials, secret keys, and other confidential information. Never include when you commit your repository. Make sure it is included in .gitignore file so it wont be included.
67+
6568
### 💬 Tech Support
6669
- If things went wrong, google it first. People ahead of you have had similar issues in the past and solved it.
6770
- Last resort. -- Contact Jorge. He'd be happy to help you.

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
"description": "Clean and minimalistic boilerplate to start your NodeJs project.",
55
"main": "app.js",
66
"scripts": {
7-
"test": "echo \"Error: no test specified\" && exit 1",
87
"start": "node app.js",
98
"hello-world": "node core/hello-world.js"
109
},

0 commit comments

Comments
 (0)