Clean and minimalistic boilerplate to start your NodeJs project.
- Building a worker scripts.
- Building scripting and automation tool.
- Stand-alone, fully customizable project.
- Creating clean file structured project.
- Following standard naming conventions so collaborators/team8s can understand easily your code.
- NodeJs Installed in your local environment.
- .env file -- Yes you need this!
- Clone the repo to your local environment.
- On the command prompt run the following commands:
run
git clone https://github.com/yortrosal/nodejs-boilerplate.gitthencd nodejs-boilerplate
- run
npm installto install initial dependencies. - Make sure you have .env file available.
Or generate one:
cp .env.example .env(edit it with your secret keys and other credentials) - Once you have the .env file setup in the main directory.
- run
▶️ npm startto start the program. It will run the script from the app.js file. - Modify the package.json file. Edit the project name and other stuff.
- Finally, start and build your application scripts. Customize your project however you like.
It has variety of usage. Find out more. 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. It's easy
nodejs-boilerplate
├── core
│ ├── custom-subfolder-example
│ │ ├── example1.js
│ │ ├── example2.js
│ │ └── example3.js
│ │
│ ├── your-script.js
│ └── hello-world.js
│
├── .env.example
├── .env
├── .gitignore
├── package.json
└── README.md
- If things went wrong, google it first. People ahead of you have had similar issues in the past and solved it.
- Last resort. -- Contact Jorge. He'd be happy to help you.
- Jorge Rosal - GitHub
- your name here...
The MIT License (MIT) Jorge Rosal