Grocery Store Management System (GSMS)

This project is a Grocery Store Management System (GSMS) application designed as a three-tier architecture. The application helps manage grocery store operations, including products and orders, using a web-based interface.

Table of Contents

• Overview
• Architecture
• Technologies Used
• Installation
• Usage
• API Endpoints
• Project Structure

Overview

The GSMS application is a web-based platform that allows users to manage products and orders within a grocery store. It provides a user-friendly interface to add, view, and manage products and orders efficiently.

Architecture

The application is designed using a three-tier architecture:

1. Front End: The user interface is developed using HTML, CSS, JavaScript, and Bootstrap.
2. Backend: The server-side logic is implemented using Python and Flask.
3. Database: MySQL is used as the database to store product and order information.

Technologies Used

• Front End:

  • HTML
  • CSS
  • JavaScript
  • Bootstrap

• Backend:

  • Python
  • Flask

• Database:

  • MySQL

Installation

Prerequisites

• Python 3.x
• MySQL server
• pip (Python package installer)

Steps

1. Clone the repository:

   git clone https://github.com/your-repository/gsms.git
   cd gsms
   

2. Set up a virtual environment:

   python3 -m venv venv
   source venv/bin/activate  # On Windows use `venv\Scripts\activate`
   

3. Install the required dependencies:

   pip install -r requirements.txt
   

4. Set up the MySQL database:

• Create a new database named gs.
• Update the database credentials in backend/sql_connection.py if necessary.
• Run the SQL scripts to create necessary tables (if available).

5. Start the Flask server:

   python server.py
   

Usage

1. Open your web browser and navigate to http://localhost:5000.
2. Use the UI to manage products and orders.

API Endpoints

• GET /getUOM: Retrieve all units of measurement.
• GET /getProducts: Retrieve all products.
• POST /insertProduct: Insert a new product.
• GET /getAllOrders: Retrieve all orders.
• POST /insertOrder: Insert a new order.
• POST /deleteProduct: Delete a product.

Notes

• Ensure that your MySQL server is running and accessible.
• Modify the database connection details in backend/sql_connection.py as needed.
• You may need to adjust file paths for CSS and JavaScript files if there are any issues with loading them.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

• Bootstrap for responsive UI components
• Flask for the web framework
• MySQL for the database management

Project Structure

gsms/
├── backend/
│   ├── __init__.py
│   ├── server.py
│   ├── sql_connection.py
│   ├── products_dao.py
│   ├── orders_dao.py
│   └── uom_dao.py
├── ui/
│   ├── css/
│   │   ├── bootstrap.min.css
│   │   ├── custom.css
│   │   ├── sidebar-menu.css
│   │   └── style.css
│   ├── js/
│   │   ├── packages/
│   │   │   ├── bootstrap.min.js
│   │   │   ├── jquery.min.js
│   │   ├── custom/
│   │   │   ├── common.js
│   │   │   ├── dashboard.js
│   │   │   ├── order.js
│   │   │   └── manage-product.js
│   ├── index.html
│   ├── manage-product.html
│   └── order.html
├── requirements.txt
└── README.md