Node JS Boilerplate

Repo will be usefull to setup NodeJS project with mongoDB as database and hadelbar as render engine this repo already has template setup for your user

---

Table of Contents

• Getting Started
• Prerequisites
• Installation
• Support
• License

---

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them

• Node JS v8.0.0+
• MongoDB v3.6+
• npm v6.4.1+

Installation

$ git clone https://github.com/Riddhish97/NodeJS-Boilerplate.git
$ npm install

Create file from sample file

• Create .env file from sample and set port
• Create databse.js file from database.sample.js

Note - Default port for mongoDB is 27017 if you have mongoDb running on different port please update it in database.js

Run this below command which will create user in mongoDB.

$ node scripts/initScripts.js

Run the project

$ node bin/www

Note - If you have docker and docker-compose install in your PC then run only the below command to start project

$ docker-compose up -d --build 

Project will start on 3000 port. You can update port in docker-compose.yml for project and mongoDB in case of docker.

---

Support

Reach out to me at one of the following places!

• Email at [email protected]
• Twitter at @mr_rajgor1997

---

License

• MIT license