Node Express Mongo

Node Express Mongo is a scaffolding or template to get started with a new Node Express project with Mongo DB connectivity using mongoose package. It also provides basic user authentication APIs and also demonstrates the use of persistence DB layer. The code linter and code formatter is also there for development environment.

Requirements

Prerequisites

You should have at least a basic understanding of fundamental programming concepts and some experience with introductory Javascript. And the knowledge of Mongo, Express and Node JS is an advantage.

Installation

Lastly, make sure you have the following installed.

• Latest version of Node.js
• Latest version of NPM (Node Package Manage)
• Latest version of MongoDB
• Latest version of git (This is optional. It requires only if you choose to clone project)

Getting Started

1. Either you can clone or download repository from GitHub.

   • Clone with HTTPS (required git installed in your system)

     git clone https://github.com/vishalnagda1/node-express-mongo.git

   • Clone with SSH (required git installed in your system)

     git clone git@github.com:vishalnagda1/node-express-mongo.git

   • Download Zip

2. Navigate to project directory in the terminal or command prompt.

   cd node-express-mongo

3. Install project dependencies

   Note: we're using yarn, if you don't want to use it replace yarn with npm.

   yarn install

4. Create a keys.js file in config directory

   • If you are using Windows Command Prompt or Powershell

     copy config/keys.sample.js config/keys.js

   • If you using Mac or Linux

     cp config/keys.sample.js config/keys.js

   Note: update keys.js file variables as per the requirements.

5. Run the project server

   • Run development server

     yarn start

   • Run production server

     yarn run start-prod

6. Project server is running at:

   • The server is running at http://localhost:8000

Contributing

1. Fork it ( https://github.com/vishalnagda1/node-express-mongo/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new pull request.