A graphical interface that displays information in the elevator lobby of Computer Science House. All information displayed has been authorized to been shown.
Documentation for the project can be found be appended /docs to the url All HTML requests that are sent in the project can be seen by appending /swag
This project uses Python, FastAPI, HTML/CSS, and Javascript. See it live here!
- Clone and cd into the repo: git clone https://github.com/WeatherGod3218/jumpstartV2
(OPTIONAL): Make another branch if your working on a large thing!
- Make sure you have docker installed
(OPTIONAL): You can use docker compose as well!!
- Copy the .env.template file, rename it to .env and place it in the root folder
- Ask an RTP for jumpstart secrets, add them to the .env accordingly
Jumpstart is containerized through a docker file.
- Build the docker file
docker build -t Jumpstart .
- Run the newly built docker on port 8000
docker run -p 8080:80 Jumpstart
Jumpstart also has support for Docker Compose, a extended version of docker that simplifies the steps.
(This is a really cool thing! If you use docker often, check it out!)
docker compose up
- Install uv on your system if not already on it (this just makes it easy)
- Run:
uv venv .venv - Activate the virtual environment
- Bash:
source .venv/bin/activate - Fish:
source .venv/bin/activate.fish - Windows:
.venv\Scripts\activate - Other: Good luck!
- Bash:
- Run:
uv pip install -r dev-requirements.txtuv pip install -r src/requirements.txtuv pip install -r tests/requirements,txtuv pip install -r docs/requirements.txt
- Run:
pre-commit install - You're all set!
We're using the pytest framework to create tests. A good minimum coverage requirement is about <=90%.
To run the tests just run: pytest
coverage.xml and htmlcov should be generated. coverage.xml is used for Sonarqube, while htmlcov is a local html view into code coverage. The easiest way to view the coverage site is to enter the directory and run: python -m http.server and visit the site!