https://github.com/maitraysuthar/rest-api-nodejs-mongodb
A boilerplate for REST API Development with Node.js, Express, and MongoDB
https://github.com/maitraysuthar/rest-api-nodejs-mongodb
api boilerplate es6 express expressjs javascript jwt-authentication mangoose mongodb nodejs rest rest-api token-based-authentication
Last synced: 21 days ago
JSON representation
A boilerplate for REST API Development with Node.js, Express, and MongoDB
- Host: GitHub
- URL: https://github.com/maitraysuthar/rest-api-nodejs-mongodb
- Owner: maitraysuthar
- License: mit
- Created: 2019-07-23T08:48:25.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-08T16:24:09.000Z (about 2 years ago)
- Last Synced: 2025-04-08T14:10:30.670Z (about 2 months ago)
- Topics: api, boilerplate, es6, express, expressjs, javascript, jwt-authentication, mangoose, mongodb, nodejs, rest, rest-api, token-based-authentication
- Language: JavaScript
- Size: 651 KB
- Stars: 1,192
- Watchers: 20
- Forks: 418
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Nodejs Expressjs MongoDB Ready-to-use API Project Structure
[](https://www.linkedin.com/in/maitray-suthar/) [](https://github.com/maitraysuthar/rest-api-nodejs-mongodb/blob/master/LICENSE)  [](https://www.codacy.com/manual/maitraysuthar/rest-api-nodejs-mongodb?utm_source=github.com&utm_medium=referral&utm_content=maitraysuthar/rest-api-nodejs-mongodb&utm_campaign=Badge_Coverage) [](https://www.codacy.com/manual/maitraysuthar/rest-api-nodejs-mongodb?utm_source=github.com&utm_medium=referral&utm_content=maitraysuthar/rest-api-nodejs-mongodb&utm_campaign=Badge_Grade) 
A ready-to-use boilerplate for REST API Development with Node.js, Express, and MongoDB
## Getting started
This is a basic API skeleton written in JavaScript ES2015. Very useful to building a RESTful web APIs for your front-end platforms like Android, iOS or JavaScript frameworks (Angular, Reactjs, etc).
This project will run on **NodeJs** using **MongoDB** as database. I had tried to maintain the code structure easy as any beginner can also adopt the flow and start building an API. Project is open for suggestions, Bug reports and pull requests.
## Advertise for Job/Work Contract
I am open for a good job or work contract. You can contact me directly on my email ([[email protected]](mailto:[email protected] "[email protected]")) or you can download my CV from my personal [website](https://maitraysuthar.github.io/portfolio/).
## Buy me a Coffee
If you consider my project as helpful stuff, You can appreciate me or my hard work and time spent to create this helpful structure with buying me a coffee.
## Features
- Basic Authentication (Register/Login with hashed password)
- Account confirmation with 4 (Changeable) digit OTP.
- Email helper ready just import and use.
- JWT Tokens, make requests with a token after login with `Authorization` header with value `Bearer yourToken` where `yourToken` will be returned in Login response.
- Pre-defined response structures with proper status codes.
- Included CORS.
- **Book** example with **CRUD** operations.
- Validations added.
- Included API collection for Postman.
- Light-weight project.
- Test cases with [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/).
- Code coverage with [Istanbuljs (nyc)](https://istanbul.js.org/).
- Included CI (Continuous Integration) with [Travis CI](https://travis-ci.org).
- Linting with [Eslint](https://eslint.org/).
## Software Requirements
- Node.js **8+**
- MongoDB **3.6+** (Recommended **4+**)
## How to install
### Using Git (recommended)
1. Clone the project from github. Change "myproject" to your project name.
```bash
git clone https://github.com/maitraysuthar/rest-api-nodejs-mongodb.git ./myproject
```
### Using manual download ZIP
1. Download repository
2. Uncompress to your desired directory
### Install npm dependencies after installing (Git or manual download)
```bash
cd myproject
npm install
```
### Setting up environments
1. You will find a file named `.env.example` on root directory of project.
2. Create a new file by copying and pasting the file and then renaming it to just `.env`
```bash
cp .env.example .env
```
3. The file `.env` is already ignored, so you never commit your credentials.
4. Change the values of the file to your environment. Helpful comments added to `.env.example` file to understand the constants.
## Project structure
```sh
.
├── app.js
├── package.json
├── bin
│ └── www
├── controllers
│ ├── AuthController.js
│ └── BookController.js
├── models
│ ├── BookModel.js
│ └── UserModel.js
├── routes
│ ├── api.js
│ ├── auth.js
│ └── book.js
├── middlewares
│ ├── jwt.js
├── helpers
│ ├── apiResponse.js
│ ├── constants.js
│ ├── mailer.js
│ └── utility.js
├── test
│ ├── testConfig.js
│ ├── auth.js
│ └── book.js
└── public
├── index.html
└── stylesheets
└── style.css
```
## How to run
### Running API server locally
```bash
npm run dev
```
You will know server is running by checking the output of the command `npm run dev`
```bash
Connected to mongodb:YOUR_DB_CONNECTION_STRING
App is running ...
Press CTRL + C to stop the process.
```
**Note:** `YOUR_DB_CONNECTION_STRING` will be your MongoDB connection string.
### Creating new models
If you need to add more models to the project just create a new file in `/models/` and use them in the controllers.
### Creating new routes
If you need to add more routes to the project just create a new file in `/routes/` and add it in `/routes/api.js` it will be loaded dynamically.
### Creating new controllers
If you need to add more controllers to the project just create a new file in `/controllers/` and use them in the routes.
## Tests
### Running Test Cases
```bash
npm test
```
You can set custom command for test at `package.json` file inside `scripts` property. You can also change timeout for each assertion with `--timeout` parameter of mocha command.
### Creating new tests
If you need to add more test cases to the project just create a new file in `/test/` and run the command.
## ESLint
### Running Eslint
```bash
npm run lint
```
You can set custom rules for eslint in `.eslintrc.json` file, Added at project root.
## Bugs or improvements
Every project needs improvements, Feel free to report any bugs or improvements. Pull requests are always welcome.
## License
This project is open-sourced software licensed under the MIT License. See the LICENSE file for more information.