Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sunilksamanta/node-mongoose-setup
Nodejs MongoDB REST API Sarter
https://github.com/sunilksamanta/node-mongoose-setup
express hacktoberfest2020 mongodb mongoose nodejs rest-api
Last synced: about 2 hours ago
JSON representation
Nodejs MongoDB REST API Sarter
- Host: GitHub
- URL: https://github.com/sunilksamanta/node-mongoose-setup
- Owner: sunilksamanta
- License: mit
- Created: 2020-09-06T05:25:56.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-06-23T11:03:34.000Z (over 2 years ago)
- Last Synced: 2023-03-05T06:50:33.329Z (over 1 year ago)
- Topics: express, hacktoberfest2020, mongodb, mongoose, nodejs, rest-api
- Language: JavaScript
- Homepage:
- Size: 242 KB
- Stars: 60
- Watchers: 2
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- Contributing: contributing.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.org/sunilksamanta/node-mongoose-setup)
[](https://codeclimate.com/github/sunilksamanta/node-mongoose-setup/maintainability)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fsunilksamanta%2Fnode-mongoose-setup?ref=badge_shield)
[](contributing.md)
[](https://github.com/sunilksamanta/node-mongoose-setup/issues)
[](https://github.com/sunilksamanta/node-mongoose-setup/stargazers)
[](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fsunilksamanta%2Fnode-mongoose-setup)
## Installation
Setup is super easy. Clone the repository -
```shell script
git clone https://github.com/sunilksamanta/node-mongoose-setup
cd node-mongoose-setup
npm install
```
Create an ``.env`` file at the root of your project with the following.
```dotenv
MONGO_URL=YOUR_MONGO_URL
PORT=5000[YOUR_DESIRED_PORT]
NODE_ENV=YOUR_APP_ENVIRONMENT[production/development]
JWT_SECRET=YOUR_JWT_SECRET_STRING
```
An example file `.env.example` is included.
Your project is ready. Now start the project.
```shell script
npm start
```
Go to ``http://localhost:5000``. You should see a default welcome page.
Your API base path is ``http://localhost:5000/api``.
First create some accounts to get started with the authentication.
## Authentication
JWT authentication is added in this project. User model is defined in models/User.js.
For Register, Login, Logout use these urls —
```
[POST] api/auth/register
[POST] api/auth/login
[GET] api/auth/logout
```
## Features
1. **Controller, Model & Service oriented architecture**
1. **Auth with JWT & Db Store**
1. **Async/Await support**
1. **User Module**
1. **Post Module** (Sample CRUD)
1. **Media Upload**
1. **Centralized Http Response**
1. **Error Handler**
1. **.env support**
1. **Multi Environment config setup**
1. **Autobind Methods**
1. **Built in Pagination**
## Directory Structure of the Project
```
├─ .env
├─ .gitignore
├─ config
│ ├─ config.js
│ ├─ database.js
│ ├─ routes.js
│ └─ server.js
├─ index.js
├─ package.json
├─ system
└─ src
├─ controllers
│ ├─ AuthController.js
│ ├─ MediaController.js
│ └─ PostController.js
├─ helpers
├─ models
│ ├─ Auth.js
│ ├─ Media.js
│ ├─ Post.js
│ └─ User.js
├─ routes
│ ├─ auth.js
│ ├─ media.js
│ └─ post.js
└─ services
├─ AuthService.js
├─ MediaService.js
├─ PostService.js
└─ UserService.js
```
## Lets talk about the structure
We have 2 base classes — One for Controller and another for Service.
1. **[Controller.js](system/controllers/Controller.js)**
This base controller have the basic CRUD operations. To create a new controller just extend this base Controller class.
2. **[Service.js](system/services/Service.js)**
This is the base Service class which includes the database operations. If you want to change the default behaviour of the services you can update this file.
## How to Create new CRUD Module?
If you want to create a new Module say Post. Then you’ll have to create 4 basic files. One Controller, one Service, one Model and one route file. And add the new route in routes/index.js with desired url.
There is a “Post” CRUD module included in this project for example.
```
controllers/PostController.js
models/Post.js
services/PostService.js
routes/post.js
```
## Overriding Base class method
As an example if you see in the media Controller — the default delete method is overriden by its own class method as we have to delete the file from the file system also. So the overriden method is like bellow —
```js
async delete(req, res, next) {
const { id } = req.params;
try {
const response = await this.service.delete(id);
// File Unlinking..
if (response.data.path) {
console.log("unlink item", response.data.path);
fs.unlink(response.data.path, function (err) {
if (err) {
console.log("error deleting file");
throw err;
}
console.log("File deleted!");
});
}
return res.status(response.statusCode).json(response);
}
catch (e) {
next(e);
}
}
```
## Have questions or suggestions?
You can reply to this article [REST API Structure using NodeJS MongoDB (Mongoose)](https://medium.com/@sunilksamanta/rest-api-architecture-using-nodejs-mongodb-mongoose-64f9021c906f)
## Want to contribute?
If you have any suggestion, feedback or you want to make this project more powerful — feel free to report issues or request a feature or suggest some changes.
Read the [Contributing guideline](contributing.md).
## License
This project is licensed under the terms of the [MIT](LICENSE) license.
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fsunilksamanta%2Fnode-mongoose-setup?ref=badge_large)
## Credit
Special thanks to [@thisk8brd](https://github.com/thisk8brd/node-starter) for the concept of this API Structure.