node-mongo-boilerplate

A simple boilerplate for NODEJS, EXPRESS and MONGODB REST API development .

Quick Start

1. Make sure you have node.js v14 + npm v8 or above installed and ts-node installed.

2. Clone this repo and cd into it using git clone [email protected]:iamsirmike/node-mongo-boilerplate.git && cd node-mongo-boilerplate.

3. This project requires a MongoDB server. Make sure you have an active MongoDB instance locally (example here) or remote (example here)

4. Create a file named .env in the base of your folder and add the mongo url from step 3 above like this

.env

MONGO_URL=<url>

Replace <url> with the actual url.

5. To get the project ready, run npm install.

6. To run the project:

   • To automatically rerun when you save, run npm run watch
   • To run once, run npm run start
   • To run tests npm run test

Now you are ready to rumble!