Comprehensive API Documentation

• Link

Language

• Python v3.10.12

Framework

• Django v4.2
• Djangorestframework v3.14.0

Docker Installation

• Make sure you have docker installed on your machine
• Clone the repository
• From the terminal, input these commands:

  docker-compose build
  docker-compose up

• Finally create a superuser (if you need to create one) with the following commands:

  docker exec -it drf_ecommerce /bin/bash
  A prompt will show up. Type:

  python manage.py createsuperuser

• You can now access localhost:8000 to check the running project

Local Installation

Step 1 - Download and Install Python

• Download python v3.10.12
• Run the executable file as an administrator
• Add python path to environment variables

Step 2 - Repository

• Clone the following repository,

  git clone  https://github.com/mohammadjayeed/e-commerce.git

Step 3 - Virtual Environment

• Make a virtual environment with the following command

  python -m venv venv

• Activate the virtual environment with the command

  venv/scripts/activate

Step 4 - Dependencies

• Install dependencies

  pip install -r requirement.txt

Step 5 - Migrations

• Run the following command to apply it to the database

  python manage.py migrate

Step 6 - Superuser

• Run the following command to create a superuser to access admin panel by adding the required information. We will require username and password to login to the admin panel

  python manage.py createsuperuser

Step 7 - Start App

• Start the application by typing the following command

  python manage.py runserver

Step 8 - Testing the App

• Test the application for models and views by typing the following command

  python manage.py test

Done !!