FastAPI Restaurant Project

Overview:

Developed a RESTful API with FastAPI for my ITSC 3155 Software Engineering final project. It exposes CRUD endpoints for customers, orders, menu items, and reviews, and delivers real-time sales and operations insights to restaurant staff.

Key Features:

  • View and manage restaurant menus

  • Place and track customer orders

  • Handle payments and promotions

  • Enable customer feedback and reviews

Setup Instructions

Prerequisites:

  • Python 3.9+

  • A virtual environment tool like venv or virtualenv

  • Dependency management through pip

  • Access to a database (e.g., PostgreSQL)

Installation Steps:

  1. Clone the Repository:

    git clone <repository_url>
cd Final-Project-master

  2. Set Up the Virtual Environment:

    python3 -m venv venv
source venv/bin/activate  # For Windows: venv\Scripts\activate

  3. Install Dependencies:

    pip install -r requirements.txt

  4. Configure Environment Variables: Create a .env file with the following:

    DATABASE_URL=postgresql://<username>:<password>@<host>:<port>/<database_name>
SECRET_KEY=<your_secret_key>

  5. Run the Server:

    python api/main.py

    The server will be accessible at http://127.0.0.1:8000/.