Mall Inventory Management App

Overview

Mall Inventory Management App is a web-based platform where customers can search products across stores, get recommendations, and use image-based search, while managers can manage products, inventory, orders, and carousel ads. The app consists of three main components:

• Client (Frontend) – React-based application
• Server (Backend) – Node.js with Express
• FastAPI (ML Model/API) – Python FastAPI backend

Project Structure

Mall Inventory Management App/

├── client/ # React frontend

├── server/ # Node.js backend

├── fastapi/ # Python FastAPI backend

└── README.md # Documentation

Prerequisites

Ensure you have the following installed:

• Node.js & npm – Download
• Python 3 – Download
• Virtual Environment (venv) for Python

Installation & Setup

1️⃣ Setup Git LFS (if not already installed)

Before cloning the repository, ensure that Git LFS is installed to handle large files (like the ML models).

1. Install Git LFS by running:

   git lfs install
   

2️⃣ Setup & Run Client (Frontend)

1. Navigate to the client folder:

   cd client

2. Install the necessary dependencies:

   npm install

3. Run the client:

   npm run dev

   The frontend will be accessible at http://localhost:5173/.

3️⃣ Setup & Run Server (Backend)

1. Navigate to the server folder:

   cd server

2. Install the necessary dependencies:

   npm install

3. Run the server:

   nodemon server.js

   The backend will be accessible at http://localhost:3000.

4️⃣ Setup & Run FastAPI (ML API)

🔹 Download & Setup the ML Model

• Download the ML Model from Google Drive: 📥 ML Model Drive Link
• Create a folder named ml_models inside the fastapi directory:

  mkdir fastapi/ml_models

• Paste the downloaded model file inside the ml_models folder.

🔹 Install Dependencies & Run FastAPI

1. Navigate to the fastapi directory:

   cd fastapi

2. Create a virtual environment for Python:

   python3 -m venv venv # Create a virtual environment

3. Activate the environment:

   • For macOS/Linux:

     source venv/bin/activate

   • For Windows:

     venv\Scripts\activate

4. Install the necessary dependencies:

   pip install -r requirements.txt

5. Run the FastAPI server:

   uvicorn fastapi_app:app --host 0.0.0.0 --port 5050 --reload

   The FastAPI server will be accessible at http://localhost:5050.

Usage

1. Start all three servers in the following order:

   a. Start FastAPI server:

   cd fastapi
   source venv/bin/activate  # or venv\Scripts\activate on Windows
   uvicorn fastapi_app:app --host 0.0.0.0 --port 5050 --reload

   b. Start Node.js backend:

   cd server
   nodemon server.js

   c. Start React frontend:

   cd client
   npm run dev

2. Open your browser and navigate to http://localhost:3000 to access the application.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.