Bulletproof Node.js Template

An industrial level NodeJS template that uses tools like TypeScript, Prettier, ESLint, Husky, PM2 and many more. The template also incorporates the MVC architecture.

Steps to start server

In-order to use docker, switch to docker branch

Clone repository

git clone https://github.com/IshaanOhri/Bulletproof-NodeJS-Template

Switch branch

git checkout pm2

Install packages

npm install

Development environment:

• Create dev.env file and add environment variables according to env.example:

touch ./src/config/dev.env

• Start server:

npm run dev

Production environment:

• Build project

npm run-script build

• Install pm2 as global package

sudo npm install -g pm2

• Change contents of ecosystem.config.js if required
• Start server:

npm start

Contributing

Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/NewFeature)
3. Commit your Changes (git commit -m 'Add some NewFeature')
4. Push to the Branch (git push origin feature/NewFeature)
5. Open a Pull Request

License

The project is distributed under the MIT License. See LICENSE for more information.

Author

• Ishaan Ohri

Tech Stacks / Tools used