shoumitro-cse / ecommerce_project

Django E-commerce Project

A Django-based E-commerce project with user management, product listings, orders, and reviews.

Table of Contents

• Installation
• Configuration
• Run the Development Server
• Run Tests
• API Documentation
• Contributing
• License

Installation

1. Clone the Repository:

   git clone https://github.com/your-username/ecommerce-project.git
   cd ecommerce-project

2. Create a Virtual Environment:

   python -m venv venv

3. Activate the Virtual Environment:

• Windows:

  venv\Scripts\activate

• Linux/Mac:

  source venv/bin/activate

4. Install Dependencies:

    pip install -r requirements.txt

5. Database Migration:

    python manage.py makemigrations
    python manage.py migrate

6. Project Clone & Run the Development Server:

   # Python version 3.xx
   git clone https://github.com/shoumitro-cse/ecommerce_project.git
   cd ecommerce-project
   python -m venv venv
   source ./venv/bin/activate
   pip install -r requirements/dev.txt
   python manage.py makemigrations
   python manage.py migrate
   python manage.py runserver

7. **Installation (using Docker Compose): **

   git clone https://github.com/shoumitro-cse/ecommerce_project.git
   cd ecommerce-project
   docker-compose up --build -d
   # or
   docker-compose up --build
   
   # username & password
   username: [e-mail]
   password: 1111

Run Tests

python manage.py test

API Documentation

  go to ---> http://localhost:8000/api/docs/