Overview

This file explains this project. It contains information that is commonly required to understand what this project is about.

Note 1: Any line that has [[remove]] after it should be removed from your file. [[remove]]

Note 2: Any line that has [[replace]] after it should be replaced with your own information. [[remove]]

Project Name [[replace]]

Project description goes here... [[replace]]

Table of contents

• Project Setup
• Project Requirements
• Database Schema
• Demo

Project Setup

In this section, the key points about technologies used in the project are mentioned, along with how the project can be run.

Technologies and Dependencies

Describe any prerequisites, frameworks, libraries, OS version, etc., needed before installing program. [[remove]]

For example: [[remove]]

• Project is created with:
  • Laravel: v9. [[replace]]
  • OS: Ubuntu 22.04. [[replace]]
  • add any extra libraries you use here if there is any [[remove]]

Installing & Executing program

• How to run your project on a local environment [[replace]]
• Use Step-by-step bullets to list the steps, and code block for commands, for example: [[replace and replace code block below]]

$ cd code
$ npm install
$ npm run dev

Project Requirements

In this section, a list of all the requirements/features of the project are presented. Put an X between the brackets for each feature that has been developed and tested by you.

Admin:

• An Admin account should be created by the developer.
• The admin should be able to log into the website.
• The logged-in admin should be able to create, list, update, and delete different product categories and subcategories.
• The logged-in admin should be able to create, list, update, and delete different products.
• The logged-in admin should be able to add and remove products from subcategories.
• The logged-in admin should be able to see a list of customer orders.
• The logged-in admin should be able to view the details of customer orders.
• The logged-in admin should be able to update any order’s status.
• The logged-in admin should be able to log out of the website.

Customer:

• The customer should be able to see a list of products on the website.
• The customer should be able to search for products by name.
• The customer should be able to filter products.
• The customer should be able to view a specific product’s details.
• The customer should be able to register an account on the website.
• The customer should be able to log into their account on the website.
• The logged-in customer should be able to add a product to their shopping cart.
• The logged-in customer should be able to view the products added to their cart.
• The logged-in customer should be able to remove a product that was added to their shopping cart.
• The logged-in customer should be able to complete their order by entering their shipping information and confirming their order.
• The logged-in customer should be able to view a list of their orders and their statuses.
• The logged-in customer should be able to view the details of their orders.
• The logged-in customer should be able to log out of the website.

Database Schema

After you have design the Database Schema, attach the diagrams to this section as images. Make sure the images are clear. [[remove]]

Demo

Add the link to the demo video that you uploaded to YouTube. [[remove]]

This video contains a complete test of the features you have developed. [[remove]]

https://youtu.be/kwvpfTC8-go [[replace]]