Nodejs Expressjs MongoDB Ready-to-use API Project Structure
A ready-to-use boilerplate for REST API Development with Node.js, Express, and MongoDB
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
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 a coffee for me. I would be very thankful if you buy me a coffee, please buy me a coffee
- 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
Authorizationheader with value
yourTokenwill 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 and Chai.
- Code coverage with Istanbuljs (nyc).
- Included CI (Continuous Integration) with Travis CI.
- Linting with Eslint.
- Node.js 8+
- MongoDB 3.6+ (Recommended 4+)
How to install
Using Git (recommended)
- Clone the project from github. Change "myproject" to your project name.
git clone https://github.com/maitraysuthar/rest-api-nodejs-mongodb.git ./myproject
Using manual download ZIP
- Download repository
- Uncompress to your desired directory
Install npm dependencies after installing (Git or manual download)
cd myproject npm install
Setting up environments
- You will find a file named
.env.exampleon root directory of project.
- Create a new file by copying and pasting the file and then renaming it to just
cp .env.example .env
- The file
.envis already ignored, so you never commit your credentials.
- Change the values of the file to your environment. Helpful comments added to
.env.examplefile to understand the constants.
. ├── 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
npm run dev
You will know server is running by checking the output of the command
npm run dev
Connected to mongodb:YOUR_DB_CONNECTION_STRING App is running ... Press CTRL + C to stop the process.
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.
Running Test Cases
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.
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.
This project is open-sourced software licensed under the MIT License. See the LICENSE file for more information.