https://github.com/amanastel/zomato-chronicles
This project demonstrates proficiency in Django, Python, database modeling, and user authentication. It is an ideal starting point for anyone looking to develop a food delivery platform or similar e-commerce applications using Django.
https://github.com/amanastel/zomato-chronicles
django-rest-framework djnago html-css-javascript mysql python python3
Last synced: 3 months ago
JSON representation
This project demonstrates proficiency in Django, Python, database modeling, and user authentication. It is an ideal starting point for anyone looking to develop a food delivery platform or similar e-commerce applications using Django.
- Host: GitHub
- URL: https://github.com/amanastel/zomato-chronicles
- Owner: Amanastel
- License: mit
- Created: 2023-08-16T07:02:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-16T06:48:28.000Z (over 1 year ago)
- Last Synced: 2025-01-13T02:41:10.586Z (5 months ago)
- Topics: django-rest-framework, djnago, html-css-javascript, mysql, python, python3
- Language: CSS
- Homepage:
- Size: 7.9 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zomato Chronicles
## Introduction
Zomato Chronicles is a Django project that simulates an online food ordering system. It allows users to browse available dishes, add them to their cart, place orders, and track their order history. This project demonstrates the implementation of a food delivery platform using Django, complete with user authentication, database models, and a responsive user interface.
## Features
- **User Registration and Authentication**: Users can register for an account, log in, and log out securely. Passwords are hashed for security.
- **Dish Management**: Admins can add, update, and delete dishes, including details like name, description, price, and availability.
- **Shopping Cart**: Users can add dishes to their shopping cart, view and edit their cart items, and place orders.
- **Order History**: Users can view their order history, including order status and total cost.
- **Search Functionality**: Users can search for dishes by name.
- **Responsive UI**: The user interface is responsive, ensuring a seamless experience on various devices.
## Prerequisites
Before you begin, make sure you have the following installed:
- Python (3.x)
- Django (install using `pip install Django`)
- Required Python packages from `requirements.txt`
## Screenshots
### Home Page
### Dish Management
### Shopping Cart
### About US
## Getting Started
Follow these steps to install and run the project:
1. Clone the repository: `git clone https://github.com/Amanastel/Zomato-django.git`
2. Navigate to the project directory: `cd Zomato-django`
3. Create a virtual environment: `python -m venv venv`
4. Activate the virtual environment:
- On Windows: `venv\Scripts\activate`
- On macOS and Linux: `source venv/bin/activate`
5. Install project dependencies: `pip install -r requirements.txt`
6. Apply database migrations: `python manage.py migrate`
7. Create a superuser for admin access: `python manage.py createsuperuser`
8. Start the development server: `python manage.py runserver`
## Usage
- Access the application at: `http://localhost:8000/`
- Admin panel is available at: `http://localhost:8000/admin/`
## API Endpoints
### Authentication
- **User Registration:** `POST /register/`
- *Description:* Allows users to register for an account.
- **User Login:** `POST /login/`
- *Description:* Allows users to log in securely.
- **User Logout:** `GET /logout/`
- *Description:* Allows users to log out.
### Dish Management
- **Add a Dish:** `POST /addDish/`
- *Description:* Allows admins to add a new dish to the menu.
- **Update Dish Availability:** `POST /update_availability//`
- *Description:* Allows admins to update the availability status of a dish.
- **Update Dish Details:** `POST /update_dish//`
- *Description:* Allows admins to update the details of a dish.
- **Delete a Dish:** `POST /delete-dish//`
- *Description:* Allows admins to delete a dish from the menu.
- **List Dishes:** `GET /dish/`
- *Description:* Retrieves a list of available dishes.
### Cart
- **View Cart:** `GET /view_cart/`
- *Description:* Allows users to view the contents of their shopping cart.
- **Update Cart Item:** `POST /update_cart_item//`
- *Description:* Allows users to update the quantity of items in their cart.
- **Add to Cart:** `POST /add_to_cart//`
- *Description:* Allows users to add a dish to their shopping cart.
- **Place an Order:** `POST /place_order/`
- *Description:* Allows users to place an order for items in their cart.
- **Order History:** `GET /order_history/`
- *Description:* Retrieves the order history for a user.
## Custom User Model
The project uses Django's built-in User model for user authentication.
## Models
- **Dish**: Represents food dishes with details such as name, price, availability, and image.
- **Menu**: Associates dishes with users and allows users to set the quantity.
- **Order**: Represents user orders, including the dishes, quantity, total price, and order status.
- **Cart**: Stores user cart items with dish details and quantity.
## Technology Stack
- Django
- Python
- Django REST framework
- HTML/CSS
- Bootstrap
## Contributing
Contributions are welcome! If you find any issues or want to add new features, feel free to open a pull request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.