Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dfanso/inventory-management-system
An Inventory Management System built with Next.js, NestJS, TypeORM, MySQL, Redis, and Chakra UI. This project allows different types of users (Admin, Manager, Viewer) to manage inventory, view items, and send reports to merchants.
https://github.com/dfanso/inventory-management-system
mysql nestjs nextjs typeorm
Last synced: 6 days ago
JSON representation
An Inventory Management System built with Next.js, NestJS, TypeORM, MySQL, Redis, and Chakra UI. This project allows different types of users (Admin, Manager, Viewer) to manage inventory, view items, and send reports to merchants.
- Host: GitHub
- URL: https://github.com/dfanso/inventory-management-system
- Owner: DFanso
- Created: 2024-07-11T16:27:14.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-24T04:59:55.000Z (6 months ago)
- Last Synced: 2024-11-13T01:14:57.236Z (2 months ago)
- Topics: mysql, nestjs, nextjs, typeorm
- Language: TypeScript
- Homepage:
- Size: 747 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Inventory Management System
An Inventory Management System built with Next.js, NestJS, TypeORM, MySQL, Redis, and Chakra UI. This project allows different types of users (Admin, Manager, Viewer) to manage inventory, view items, and send reports to merchants.
## Technologies Used
## Features
- **Admin**
- Manage users (add, update, disable)
- Perform all Manager and Viewer tasks
- **Manager**
- Add, remove, and update inventory items
- Send inventory summary reports to merchants
- Perform all Viewer tasks
- **Viewer**
- View inventory items and their quantities
## Prerequisites
- Node.js
- Yarn
## Getting Started
### Backend
1. Clone the repository:
```bash
cd backend
```
2. Install dependencies:
```bash
yarn install
```
3. Set up environment variables in a `.env` file in the backend root:
```env
MYSQL_HOST=
MYSQL_PORT=
MYSQL_DATABASE=
MYSQL_USERNAME=
MYSQL_PASSWORD=
MYSQL_SYNCHRONIZE=
JWT_SECRET=
BREVO_SMTP=
BREVO_USER=
BREVO_PASS=
[email protected]
REDIS_HOST=
REDIS_PORT=
REDIS_PASSWORD=
```
4. Run the backend server:
```bash
yarn dev
```
The backend API will be available at `http://localhost:9000/v1` and the Swagger documentation at `http://localhost:9000/doc`.
### Frontend
1. Navigate to the frontend directory:
```bash
cd ../frontend
```
2. Install dependencies:
```bash
yarn install
```
3. Set up environment variables in a `.env.local` file in the frontend root:
```env
NEXT_PUBLIC_API_URL=http://localhost:9000/v1
```
4. Run the frontend server:
```bash
yarn dev
```
The frontend will be available at `http://localhost:3000`.
### Kubernetes (k8s)
1. The Kubernetes manifests for deploying the services are located in the `k8s` directory.
2. The list of YAML files in the directory are as follows:
- `brevo-secret.yaml`
- `jwt-secret.yaml`
- `mysql-secret.yaml`
- `mysql.yaml`
- `nestjs.yaml`
- `nginx.yaml`
- `redis-secret.yaml`
- `redis.yaml`
These files contain the necessary configurations for deploying the backend, database, Redis, and other related services on a Kubernetes cluster.
### NGINX
NGINX is used as the load balancer in this setup. The `nginx.yaml` file in the `k8s` directory contains the configuration for setting up NGINX to manage traffic to the backend services.