ByteSyntax - Parcel Tracking System

A modern, full-stack parcel management and tracking system designed for student centers and administration offices.

🚀 Quick Start Guide...

1. Prerequisites

• Python 3.10+
• Node.js (LTS)
• XAMPP (for MySQL)

---

2. Backend Setup

1. Navigate to Backend directory:

   cd Backend

2. Create & Activate Virtual Environment:

   python -m venv venv
   .\venv\Scripts\activate

3. Install Dependencies:

   pip install -r requirements.txt

4. Configure Environment: Create a .env file based on the existing template and add your:
   • DATABASE_URL (MySQL)
   • MAIL_USERNAME & MAIL_PASSWORD (Gmail App Password)
5. Mobile/Network Access (Optional): If you want to access the app from your phone on the same Wi-Fi:

   # Run from Backend directory
   python -m uvicorn main:app --reload --host 0.0.0.0

   Note: On your phone's browser, use http://<YOUR_IP>:5173.

---

3. Frontend Setup

1. Navigate to Frontend directory:

   cd Frontend

2. Install Dependencies:

   npm install

3. Run Application:

   npm run dev

   For Mobile/Network access:

   npm run dev -- --host

   (Note: Use npm.cmd if PowerShell blocks the run script)

---

🛠️ Key Features

• Admin Dashboard: Real-time stats and parcel management.
• Secure Auth: JWT-based login with "Forgot Password" recovery.
• Email Notifications: Real-time password reset emails.
• Public Tracking: Secure 3-factor lookup for students.
• Premium UI: Modern typography (Outfit & Inter) with smooth animations.

---

📄 Documentation

• Tech Stack
• API Documentation
• SQL Schema