/node_boilerplate

This is a boilerplate for Node JS web app.

Primary LanguageJavaScript

Node Boilerplate 1.0.0

This is a boilerplate for Node JS web application supported with express js framework and mongoose.

Install

For installing this project in your local you need to follow below steps -

  1. git clone https://github.com/kaustav1808/node_boilerplate.git
  2. cd node_boilerplate
  3. npm install

Running the project

  1. create .env file in the project root directory.
  2. add DB_CONNECTION_STRING = mongodb+srv://<username>:<password>@<hostname>/<dbname>?retryWrites=true&w=majority in .env file, where username would be your mongodb username, password would be the password and dbname would be the database you want to create.
  3. run the command npm start.

This boilerplate application is designed based on Test Driven Development (TDD)

Testing the application

For testing the application you need to run the following command -

  • npm test