NodeJs & Mongodb - API end points

NodeJs & Mongodb - API end points

Getting started

This is a basic API skeleton written in JavaScript ES6. Very useful to building a RESTful web APIs

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. ]

Features

• Pre-defined response structures with proper status codes.
• Included CORS.
• Book example with CRUD operations.
• Included API collection for Postman. LINK
• Light-weight project.
• Test cases with Mocha and Jest.

Software Requirements

• Node.js 15+

How to install

Using Git (recommended)

1. Clone the project from github. Change "myproject" to your project name.

git clone https://github.com/SakibHasanCse/Nodejs-Rest-Api.git ./myproject

Using manual download ZIP

1. Download repository
2. Uncompress to your desired directory

Install npm dependencies after installing (Git or manual download)

cd myproject
npm install || yarn add

Setting up environments

1. You will find a file named congig/config.env on root directory of project.

Project structure

.
├── app.js
├── package.json
├── bin
│   └── www
├── controllers
│   └── Book.js
├── models
│   ├── Book.js
├── routes
│   └── book.js
├── helpers
│   ├── apiResponse.js
└── test
    ├── testConfig.js
    └── book.test.js

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.

Note: YOUR_DB_CONNECTION_STRING will be your MongoDB connection string.

Tests

Running Test Cases

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.

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.