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, UV, 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 --build
Install UV on your system if not already on it. If you already have it installed, you can skip down to the Project Setup page
UV is a blazingly fast python package manager written in Rust. The Jumpstart project uses UV for speed and simplicity. Run the linked install command for your operating system
Linux and macOS
curl -LsSf https://astral.sh/uv/install.sh | sh
Windows (Powershell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
uv sync: UV sync serves to replace pip install -r requirements.txt. This command syncs your virtual environment to match the pyproject.toml file. By default, it will only copy the default dependencies for the project (found in dependencies)
uv sync --group $GROUP: UV sync with the added group flag will ALSO install all dependencies found in that group ALONG with the default dependencies.
uv sync --frozen: When reading the UV Sync, it reads ONLY the uv.lock file, and does not attempt to make any modifications, and failing instead. This is incredibly useful for reproducibility, which is why its used in the docker file.
uv sync --all-groups: UV sync, along with installing dependencies of every group
uv add $PACKAGE: UV serves to replace pip install $PACKAGE. It installs the most recent version of the inserted package, and adds it to the projects default dependencies
uv add --group $GROUP $PACKAGE: Same as UV add, but adds the package to the group instead of the default project dependencies.
dev: Dependencys needed for testing locally
docs: Dependencys used for creating the statically generated website on /docs
tests: Dependencys used for running the unit tests.
- Run:
uv venv .venv --python 3.14 - 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 sync --all-groups - 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!