uvicorn api.main:app --reload --port 8000
Welcome to the Restaurant Ordering System! This project provides a streamlined platform for managing restaurant menus and processing customer orders efficiently.
- Menu Management: Easily add, update, and remove menu items.
- Order Processing: Handle customer orders with real-time updates.
- Database Integration: Utilizes SQLite for data storage.
Follow these steps to set up and run the project on your local machine.
Ensure you have the following installed:
- Python 3.x
pip(Python package installer)
-
Clone the Repository:
git clone https://github.com/haroonqa/ResturantOrderingSystem.git
-
Navigate to the Project Directory:
cd ResturantOrderingSystem
-
Install Required Packages:
pip install -r requirements.txt
Initialize the database and apply migrations:
-
Initialize the Database:
python initialize_db.py
-
Apply Migrations:
alembic upgrade head
-
Add Sample Menu Items (Optional):
python add_sample_menu.py
Start the application using Uvicorn:
uvicorn api.main:app --reload --port 8000
The application will be accessible at http://localhost:8000.
GET /menu: Retrieve all menu items.POST /menu: Add a new menu item.PUT /menu/{item_id}: Update an existing menu item.DELETE /menu/{item_id}: Remove a menu item.POST /order: Place a new order.GET /order/{order_id}: Retrieve details of a specific order.
Contributions are welcome! To contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature/YourFeature). - Commit your changes (
git commit -m 'Add your feature'). - Push to the branch (
git push origin feature/YourFeature). - Open a Pull Request.