https://github.com/abrehan2/inventory-system-api

https://github.com/abrehan2/inventory-system-api

expressjs mongodb-atlas nodejs

Last synced: 30 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/abrehan2/inventory-system-api
• Owner: abrehan2
• License: mit
• Created: 2023-09-08T13:25:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-11T07:03:43.000Z (over 1 year ago)
• Last Synced: 2023-09-11T08:26:56.412Z (over 1 year ago)
• Topics: expressjs, mongodb-atlas, nodejs
• Language: JavaScript
• Homepage: https://inventory-system-api.vercel.app
• Size: 30.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
> This is a back-end of the [Inventory-System-UI](https://github.com/abrehan2/Inventory-System-UI.git)

### Run the commands below to get started ⚙️

```nodejs

  git clone https://github.com/abrehan2/Inventory-System-API.git

```

```nodejs

  npm install

```

### Kindly set up the following environment variables within the `config/config.env` file 🔎

> `PORT` `DB_URL` `JWT_SECRET` `JWT_EXPIRE` `COOKIE_EXPIRE` `FRONTEND_URL` `SMPT_SERVICE` `SMPT_MAIL` `SMPT_PASSWORD` `SMPT_HOST` `SMPT_PORT` `CLOUD_NAME` `API_KEY` `API_SECRET`

# Back-End Structure 🛠

    .                    

    │   └── config      # Stores all the database configurations

    │   └── controllers # Stores all the components to handle client-side requests

    │   └── middlewares # Stores all the middlewares to be used throughout the application

    │   └── models      # Stores all the schemas to be used throughout the application

    │   └── routes      # Stores all the API routes

    │   └── utils       # Stores all the features, email and JSON web token configurations, and the error-handling root class

    |   ├── app.js      # Instantiates all the routes and middlewares

    |   ├── server.js   # Entry point for a server

    └──