Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manavjain01/inventory.management.system-express.typescript
1st Assessment of 75way technologies - Backend/Typescript
https://github.com/manavjain01/inventory.management.system-express.typescript
express-js jwt-bearer-tokens mongodb nodemailer rbac-management typescript
Last synced: 10 days ago
JSON representation
1st Assessment of 75way technologies - Backend/Typescript
- Host: GitHub
- URL: https://github.com/manavjain01/inventory.management.system-express.typescript
- Owner: ManavJain01
- Created: 2025-01-16T04:56:13.000Z (23 days ago)
- Default Branch: main
- Last Pushed: 2025-01-24T06:07:32.000Z (15 days ago)
- Last Synced: 2025-01-24T07:19:30.819Z (15 days ago)
- Topics: express-js, jwt-bearer-tokens, mongodb, nodemailer, rbac-management, typescript
- Language: TypeScript
- Homepage:
- Size: 29 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Inventory Management System
## Overview
The Inventory Management System is a full-stack application designed to streamline the management of warehouses, products, and inventory. The application supports multiple user roles: **USER**, **ADMIN**, and **MANAGER**, each with specific permissions and capabilities.
---
## Features
### Authentication
- **Login/Signup** for all roles (USER, ADMIN, MANAGER) using:
- Name
- Email
- Password
- Role
### Role-Based Functionalities
#### ADMIN
- Create and manage **warehouses**.
- Attributes: `name`, `location`, `managerID`
#### MANAGER
- Create and manage **products**.
- Attributes: `name`, `price`
- Manage inventory using the **stack schema**.
- Attributes: `warehouseId`, `productId`, `quantity`, `lowStackThreshold`
#### USER
- Access and view relevant information as per assigned role permissions.
---
## Data Models
### User Schema
```javascript
{
name: String,
email: String,
password: String,
role: String // Possible values: "USER", "ADMIN", "MANAGER"
}
```
### Warehouse Schema
```javascript
{
name: String,
location: String,
managerID: String // ID of the assigned manager
}
```
### Inventory Schema
```javascript
{
name: String,
price: Number
}
```
### Stock Schema
```javascript
{
warehouseId: String, // ID of the warehouse
productId: String, // ID of the product
quantity: Number, // Available quantity in stock
lowStackThreshold: Number // Threshold for low stock alerts
}
```
---
## Installation
### Prerequisites
Ensure you have the following installed:
- **Node.js**
- **MongoDB** (or your preferred database)
### Steps
1. Clone the repository:
```bash
git clone
```
2. Navigate to the project directory:
```bash
cd inventory-management-system
```
3. Install dependencies:
```bash
npm install
```
4. Set up environment variables in a `.env` file:
```env
PORT=5000
MONGO_URI=your_mongodb_connection_string
MAIL_USER = "[email protected]"
MAIL_PASS = "password123"
FE_BASE_URL = "http://localhost:3000"
REFRESH_TOKEN = "refreshtoken";
ACCESS_TOKEN = "accesstoken"
```
5. Start the server:
```bash
npm run local
npm run dev
npm run prod
```
---
## API Endpoints
### Authentication
- **POST** `/users/` - Register a new user.
- **POST** `/auth/login` - Login to the system.
- **POST** `/auth/logout` - Logout from the system.
- **POST** `/auth/forgot-password` - Email the User to reset password.
- **POST** `/auth/reset-password` - Reset the Password.
- **POST** `/auth/refresh-token` - regenerate access token
### Admin
- **POST** `/warehouse` - Create a new warehouse.
- **GET** `/warehouse` - List all warehouses.
- **GET** `/warehouse/:id` - View a specific warehouse.
### Manager
- **POST** `/inventory` - Create a new product.
- **GET** `/inventory` - List all products.
---
## Technologies Used
- **Backend**: Node.js, Express
- **Database**: MongoDB
- **Authentication**: JSON Web Tokens (JWT), Nodemailer
---
## License
This project is licensed under the MIT License.
---
## Contribution
Contributions are welcome! Feel free to fork the repository and submit a pull request.
---
## Contact
For any queries or issues, please contact:
- **Manav Jain**
- Email: [[email protected]](mailto:[email protected])