/WaiterShop

E-commerce website with django & REST

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

WaiterShop

WaiterShop is a simple shop application with RESTAPI, where users can buy products .

Setup

  1. Download the Repository to your local machine
  2. Create a Virtual Environment in the WaiterShop folder with this command below
    python -m venv venv
  3. Activate the environment with this command
    .\venv\Scripts\activate
  4. Install the dependencies
    pip install -r requirements.txt

Running the Application

  1. Activate the environment with this command.
    .\venv\Scripts\activate
  2. Start the application by running this command (Run the command where manage.py is located)
    python manage.py runserver

Accessing Admin Panel

  1. You can access the admin panel by running the server and opening http://localhost:8000/admin
  2. Run python manage.py createsuperuser to create a user to access the admin panel.
  3. Set up the Username and Password
  4. You can log in and change the database values anytime.

How buy products

  1. In home or our products page click on one item
  2. you should see price and detail of those item
  3. if you want it, click add to cart
  4. login to site
  5. you can back to products page with continue shopping botton and add other items in your cart
  6. or click on proceed to checkout for buy your cart items
  7. fill your shipping adress form
  8. if you have shipping address in site,you can use Use default shipping address checkbox
  9. choice your payment option
  10. click continue to checkout

User Stories

  • A user can rate products if logged in .
  • A user can have refund request with bill code on 'request-refund/' endpoint .
  • A user can have coupon for reduce the price .
  • A user can search products on top navigation .

Features

  • category
    • items ordered by category
    • can click on category name and just see items for those category

Dependencies

  • Python
  • Django
  • SQLite
  • Redis
  • DRF
  • Django Packages

What the app looks like

ScreenShot

ScreenShot

Testing Tool

WaiterShop makes use of Coverage.py. As taken from their website, "Coverage.py is a tool for measuring code coverage of Python programs. It monitors your program, noting which parts of the code have been executed, then analyzes the source to identify code that could have been executed but was not."

Running Tests

Running tests can be done using the following command: coverage run manage.py test.

Obtaining the coverage report in the command line can then be done using: coverage report.

Alternatively, the following command can be used to obtain the coverage report in HTML-format: coverage html.

NB: You'll need to re-run the first command each time you make a change to your source code or test file in order to obtain an up-to-date coverage report.

Ignoring Files

Only files with a .py extension are tested by default.

RESTAPI

this api is based on JWT Auth, if you dont know RESTfulAPI what is it, visit https://restfulapi.net/ .

URLs