Skip to content

MahirMahdi/PlataServ

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

93 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Logo

Plataserv - Restaurant Management System

About Plataserv

This is a comprehensive restaurant management system that includes a point-of-sale (POS) system, speed of service tracking, financial reporting, inventory management, and a PAR (Periodic Automatic Replenishment) builder. This project is built using React, Express, MongoDB, Node.js, Chakra UI, React-Chartjs-2, Imagekit, and Axios.

(back to top)

Built With

  • React
  • Node.js
  • Express
  • MongoDB
  • ChakraUI

(back to top)

Features

  • POS system: Users can create orders, and track order statuses.

  • Speed of service tracking: The system records the time it takes to serve orders and provides reports on average service times.

  • Financial reporting: The system generates reports and charts on revenue, expenses, and wastes, with the ability to filter by date range.

  • Inventory management: The system is capable of monitoring the inventory levels and providing automatic alerts for items that are either running low on stock or approaching their expiration dates.

  • PAR builder: The system generates PARs based on inventory levels, sales, and waste data, helping users manage their inventory more effectively.

(back to top)

Installation

Clone the repo

  git clone https://github.com/MahirMahdi/PlataServ.git

Client

  1. Change directory and install dependencies
    cd client
    npm install
  2. Create a .env
    cp .env.example .env
    
  3. Go to .env and fill up the credential using your imagekit url
    VITE_CDN_URL = 'YOUR_IMAGEKIT_URL'
    
  4. Start the server
    npm start

This will start the server on http://localhost:5173

Server

  1. Change directory and install dependencies
    cd server
    npm install
  2. Create a .env
    cp .env.example .env
    
  3. Go to .env and fill up the credentials using your imagekit URL, private key, and public key
    CDN_URL = 'YOUR_IMAGEKIT_URL'
    CDN_PRIVATE_KEY = 'YOUR_IMAGEKIT_PRIVATE_KEY'
    CDN_PUBLIC_KEY = 'YOUR_IMAGEKIT_PUBLIC_KEY'
    
  4. Start the server
    npm start

This will start the server on http://localhost:5000

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)