csc-swe-primetime's Introduction

CSC-SWE-PrimeTime

An ecommerce platform for shoe lovers

Developers

Yonatan Teklu
Natania Tedla
Leah Cheong
Amrith Balaguhan
Isaac Harris

Project Structure

• README.md                                             # You are here
• sprintdoc                                             # contains information about project sprints
• app
├── src
|   └── • prime.py                                      # contains the FastAPI app and event coroutines
|       ├── routers
|       |   ├── • main.py                               # contains the standard routes for the application
|       |   ├── • item.py                               # handles CRUD routes for items
|       |   └── • user.py                               # handles authentication and registration
|       ├── models
|       |   └── • datamodels.py                         # contains pydantic models for validation
|       ├── util
|       |   └── • utils.py                              # container any misc. utilities for reuse
|       └── tests                                       # contains testclient code
└──

Installation

Prepare a runtime environment

Install Python 3.10 or later
git clone this repo
Use cd CSC-SWE-PrimeTime to enter the local repo directory
Run python -m venv venv to create a virtual Python environment

Get Required Dependencies

If not activated automatically, use source venv/bin/activate on Linux, venv/scripts/activate.bat on Windows CMD, or venv/scripts/Activate.ps1 on Powershell for Windows
Run python -m pip install -r requirements.txt to get dependencies
(If your Python 3 binary isn't python, use what you have eg: for py, use py -m pip ...)
(If pip is installed to the system, leave off the call to Python)