ChocoLux Project

Create by Ori Shai

---

ChocoLux is a web application for a chocolate company, allowing users to view and purchase various chocolate items.

Table of Contents

• Features
• Client's Features
• Admin's Features
• DB Structure
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Reference
• Login Details

Features

Client's Features

• View a list of chocolate items with details.
• Add/Remove items to the shopping cart.
• Check out and place orders.

Admin's Features

• Add new Items to the database.
• Show reports on the order history.

DB Structure:

• EER Diagram

• DB Structure

SQL Quiries:

• Tables (like to sql query file):

• users - Stores user information.

• items - Stores chocolate items information.

• orders - Stores orders information.

• address_details - Stores address information.

• payment_details - Stores payment information.

• shopping_cart - Stores shopping cart information.

• shopping_cart_details - A view that comabins the shopping cart and the items table.

• user_order_total - A view that joins all the tables above, and shows the total amount of orders per user.

Sqeuence Diagrams:

Getting Started

Prerequisites

Make sure you have the following installed:

• Python (version 3.11.6)
• Flask (version 3.0.0)
• mySQL (version 8.0.26)

Installation

1. Clone the repository: https://github.com/sholker/Chocolux.git
2. cd chocolux
3. pip install -r requirements.txt
4. Windows:

     set FLASK_APP=app.py
     set FLASK_ENV=development
     flask run

   Linux:

      git clone https://github.com/sholker/Chocolux.git
      cd chocolux
       export FLASK_APP=app.py
       export FLASK_ENV=development

Usage

• To run the application, run the following command in the terminal:

• flask run
  # then in browser, open
  http://127.0.0.1:5000/
  

Reference

Frontend

• use this link to see the live demo: https://themewagon.github.io/chocolux/
• use this link for error pages: https://codepen.io/uiswarup/pen/XWdXGGV

Login Details:

Type	Username	Password
Client	daredevil	123
Client	spiderman	123
Client	deadpool	123
Admin	moonknight	admin
Admin	admin	admin