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 instructed 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. To complete each project milestone, OS-specific dependencies (such as Graphviz for generating UML diagrams) may need to be installed. These dependencies are listed in the project instructions.
All module dependencies are listed in the requirements.txt file. To install these dependencies, run the following command from the root of the repository:
pip3 install -r requirements.txt
# Note: depending on your system, you may need to use `pip` or `python3.10 -m pip1 instead of `pip3`The project uses a SQLite database, which is stored in the database directory. Each time the server is started, the database is reset to its original state.
Once all installation steps are complete, the app.py script can be run to start the server. Follow the local server URL that is printed to the console to view the website.
Across all files, classes and functions are documented using docstrings, which are formatted according to the Google Python Style Guide.
Additionally, detailed documents for the project code folders (authentication, core, database, static templates, and tests) have been provided in the docs/directories folder. These documents describe the purpose of each file in the folder and how they interact with each other.
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.