Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iamtonmoy0/node-express-mongoose-inventory-management-system

A ready-to-use inventory management system with Node.js, Express, and Mongoose.
https://github.com/iamtonmoy0/node-express-mongoose-inventory-management-system

api-server express inventory inventory-management-system mongodb mongoose node rest rest-api restful-api server

Last synced: 5 days ago
JSON representation

A ready-to-use inventory management system with Node.js, Express, and Mongoose.

Awesome Lists containing this project

README

        

A ready-to-use inventory management system with Node.js, Express, and Mongoose.

## Getting started
This project will run on **NodeJs** using **Mongoose** 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.

## Software Requirements

- Node.js **8+**
- Mongoose **5.12** (Recommended **5+**)

## How to install

### Using Git (recommended)

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

```bash
git clone https://github.com/iamtonmoy0/node-express-mongoose-inventory-management-system.git
```

### Using manual download ZIP

1. Download repository
2. Uncompress to your desired directory

### Install npm dependencies after installing (Git or manual download)

```bash
cd projectFileName
npm i
```

## Project structure

```sh
.
├── app.js
├── package.json
├── .env
├── controllers
│ ├── product.controller.js

├── models
│ ├── product.model.js
│ ├── brand.model.js
| ├── category.model.js
| ├─ store.model.js
├── routes
│ ├── product.router.js
├── middlewares

├── helpers
├── service
│ ├── product.services.js

└── views
├── index.pug
```

## How to run

### Running API server locally

```bash
nodemon app.js
```