This repository contains template code for a simple online store, built for my students in ITSC 3155 - Software Engineering at UNC Charlotte. Since the code is written as a starting template for students' group final projects, this repository should not be seen as a complete, production-ready online store. Functional features like user session management, database access, unit testing, and server-side rendering are included but kept at an abstract level. Users are encouraged to fork this repository and customize it to the needs of their own project.
To run this project, you simply need to have Python 3.10 installed on your machine. You can download Python 3.10 from the official website.
A script titled setup.sh is included at the root of this repository, which will automatically install the required dependencies and set up the database. To run this script, execute the following command:
bash setup.shIf you instead prefer to manually install the python module dependencies, run the following command:
pip install -r requirements.txt # or pip3 install -r requirements.txt if pip is not set to use Python 3Another script titled run.sh is also included at the root of this repository, which will automatically run the application. Execution of this script is recommended but not required. If you would like to manually run the server, run the following command:
./run.sh # or bash run.sh if permissions are not setAcross all files, classes and functions are documented using docstrings, which are formatted according to the Google Python Style Guide.
Additionally, authentication, core, database, static templates, and tests each contain their own README.md file, where the contents of each directory are described in more detail.
The unit tests are kept across various files in the testing directory. From the root of the repository, you can run the test.py script to check all unit tests, which will generate a report in the testing/reports directory.