sankalpkataria / node-mongo-starter

Node-mongo-starter

Node JS boiler plate using express JS.

Prerequisites

    node, mongoDB

Usage

• Run npm i to install all the dependencies.
• Start mongoDB server.
• Add .env file to the root of this project with following configuration.

PORT=<Port of your choice>
ENV=<Environment development/production>
SECRET=<Some strong secret>
MONGO_URI=<Mongo DB uri>

• Run npm start to run the server.

Test

This app uses jest for unit testing.

To run test-cases, run npm test.

API Documentations

This app uses swagger for API docs.

Documentation can be found at /api/v1/api-docs

Built With

The app is built using the following components.

• MongoDB
• Express
• Node.js