Online Shop Project

Table of Contents

• Overview
• Features
  • Authentication
  • Shopping Cart
  • Product Management
  • Search
  • Other Features
• Technologies Used
• Project Structure
• Installation and Setup
• Usage
  • User Authentication
  • Browse Products
  • Search
  • Manage Cart
  • Checkout
• API Documentation
• Contributing
• License
• Contact

Overview

This project is an Online Shop with separate frontend and backend implementations, both developed using Django. The application provides a seamless shopping experience with modern e-commerce features.

Features

Authentication:

• Register and Login with a password.
• Login with OTP (One-Time Password).

Shopping Cart:

• Add items to the cart.
• Increment/Decrement item quantities in the cart.
• Remove items from the cart.

Product Management:

• Categorized and sub-categorized items.
• Detailed view for each product.

Search:

• Search functionality to find products quickly.

Other Features:

• User-friendly UI.
• Optimized for scalability and maintainability.

Technologies Used

• Backend: Django (Django REST Framework for APIs if applicable).
• Frontend: Django Templates (or another frontend framework if specified).
• Database: SQLite/PostgreSQL (or the database you're using).
• Authentication: Django's built-in authentication and custom OTP implementation.

Project Structure

Installation and Setup

Follow these steps to run the project locally:

1. Clone the Repository:

   git clone https://github.com/your-repo-name/online-shop.git
   cd online-shop

2. Set up a virtual environment:

    python -m venv venv
    source venv/bin/activate  # On Windows use `venv\Scripts\activate`

3. Install dependencies:

    pip install -r requirements.txt

4. Run Migrations:

    python manage.py makemigrations
    python manage.py migrate    

5. Run the Development Server:

    python manage.py runserver

6. Access the Application

Open your browser and navigate to http://127.0.0.1:8000.

---

Usage

User Authentication:

• Register for a new account or log in using a password or OTP.

Browse Products:

• Explore products by categories and subcategories.

Search:

• Use the search bar to find specific products.

Manage Cart:

• Add, update, or remove items in your shopping cart.

Checkout:

• Proceed to purchase your selected items.

---

API Documentation

Django REST Framework

• Base URL: http://127.0.0.1:8000/api/
• Example Endpoints:
  • GET /products/ - List all products.
  • POST /cart/add/ - Add item to the cart.
  • POST /auth/login/ - Log in using credentials.

---

Contact

If you have any questions or feedback, feel free to contact us at alikaramouzian@icloud.com