https://github.com/trulymittal/nodejs-rest-api

This is a RESTful API example based on Node.js and MongoDB, following the MVC pattern i.e. Model View Controller.
https://github.com/trulymittal/nodejs-rest-api

Last synced: 7 days ago
JSON representation

This is a RESTful API example based on Node.js and MongoDB, following the MVC pattern i.e. Model View Controller.

• Host: GitHub
• URL: https://github.com/trulymittal/nodejs-rest-api
• Owner: trulymittal
• Created: 2019-12-13T11:48:06.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T17:05:37.000Z (almost 2 years ago)
• Last Synced: 2023-05-05T00:35:06.587Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 196 KB
• Stars: 64
• Watchers: 3
• Forks: 75
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# RESTful API

This is a RESTful API example based on Node.js and MongoDB, following the **MVC pattern** i.e. Model ~~View~~ Controller.

**Mongoose** is used for Database transactions which is an elegant solution to mongodb object modeling for node.js.

The application is **production ready**, and can be used behind a Nginx reverse proxy securely.

---

#### To start setting up the project

Step 1: Clone the repo

```bash

git clone https://github.com/trulymittal/Nodejs-REST-API.git

```

Step 2: cd into the cloned repo and run:

```bash

npm install

```

Step 3: Put your credentials in the .env file.

```bash

PORT=3000

MONGODB_URI=YOUR MONGODB URI

DB_NAME=DATABASE NAME OF YOUR CHOICE

DB_USER=DATABASE USER

DB_PASS=DATABASE USER PASSWORD 

```

Step 4: Start the API by

```bash

npm start

```

## Author

- [**Truly Mittal**](https://trulymittal.com)

## License

This project is licensed under the MIT License.