ComputerScienceHouse · WeatherGod3218 · Apr 9, 2026 · Mar 27, 2026 · Mar 27, 2026 · Mar 27, 2026
diff --git a/.github/workflows/sonarqube.yml b/.github/workflows/sonarqube.yml
@@ -20,9 +20,19 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.13'
+          python-version: '3.14'
+
+      - name: Install dependencies
+        run: |
+          pip install uv
+          uv pip install -r src/requirements.txt --system
+          uv pip install -r tests/requirements.txt --system
+
+      - name: Run tests with coverage
+        run: |
+          pytest -v
 
       - uses: SonarSource/sonarqube-scan-action@v6
         env:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
diff --git a/.gitignore b/.gitignore
@@ -185,9 +185,9 @@ cython_debug/
 .abstra/
 
 # Visual Studio Code
-#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
 #  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
-#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
 #  you could uncomment the following to ignore the entire vscode folder
 # .vscode/
 

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.6
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-json
diff --git a/.python-version b/.python-version
@@ -1 +1 @@
-3.14
+3.14
diff --git a/Dockerfile b/Dockerfile
@@ -21,4 +21,4 @@ RUN addgroup -g 2000 jumpgroup && adduser -S -u 1001 -G jumpgroup jumpstart && \
 
 USER jumpstart
 
-CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000", "--log-config", "/jumpstart/logging_config.yaml", "--proxy-headers","--forwarded-allow-ips","*"]
+CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000", "--log-config", "/jumpstart/logging_config.yaml", "--proxy-headers", "--forwarded-allow-ips", "*"]
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ 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](https://fastapi.tiangolo.com/), HTML/CSS, and Javascript. 
+This project uses Python, [FastAPI](https://fastapi.tiangolo.com/), HTML/CSS, and Javascript.
 See it live [here](http://jumpstart-cubed.cs.house/)!
 
 ## Installing
@@ -46,3 +46,28 @@ Jumpstart also has support for Docker Compose, a extended version of docker that
     docker compose up
 ```
 
+## Development
+
+### Setup
+1. Install uv on your system if not already on it (this just makes it easy)
+2. Run: `uv venv .venv`
+3. Activate the virtual environment
+    * Bash: `source .venv/bin/activate`
+    * Fish: `source .venv/bin/activate.fish`
+    * Windows: `.venv\Scripts\activate`
+    * Other: Good luck!
+4. Run:
+    * `uv pip install -r dev-requirements.txt`
+    * `uv pip install -r src/requirements.txt`
+    * `uv pip install -r tests/requirements,txt`
+    * `uv pip install -r docs/requirements.txt`
+5. Run: `pre-commit install`
+6. You're all set!
+
+### Testing
+
+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!
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -0,0 +1,2 @@
+pre-commit==4.5.1
+ruff==0.15.6
diff --git a/docs/core/CSH Calendar.md → docs/core/csh_calendar.md b/docs/core/CSH Calendar.md → docs/core/csh_calendar.md
@@ -1,5 +1,3 @@
-## Overview
-
 This core component is used for all the fetching, formatting and structuring for the CSH calendar portion of Jumpstart.
 
 ---
@@ -11,4 +9,4 @@ During a fetch of the calendar, if any other clients attempt to connect, they wi
 ---
 
 ### Documentation Overview
-::: core.cshcalendar
+::: core.cshcalendar
diff --git a/docs/core/Slack.md → docs/core/slack.md b/docs/core/Slack.md → docs/core/slack.md
@@ -1,8 +1,6 @@
-## Overview
-
 This component handles the Slack Bot and it's related functions. Such as responding to announcments, requesting to upload to Jumpstart, and the other handles with Slack.
 
 ---
 
 ### Documentation Overview
-::: core.slack
+::: core.slack
diff --git a/docs/core/Wiki-thoughts.md → docs/core/wikithoughts.md b/docs/core/Wiki-thoughts.md → docs/core/wikithoughts.md
@@ -11,4 +11,4 @@ This component handles the fetching, caching and cycling of the CSH Wikithoughts
 ---
 
 ### Documentation Overview
-::: core.wikithoughts
+::: core.wikithoughts
diff --git a/docs/endpoints/announcements.md b/docs/endpoints/announcements.md
@@ -1,3 +1,3 @@
 
 
-::: api.endpoints.get_announcement
+::: api.endpoints.get_announcement
diff --git a/docs/endpoints/calendar_endpoint.md → docs/endpoints/csh_calendar.md b/docs/endpoints/calendar_endpoint.md → docs/endpoints/csh_calendar.md
@@ -25,4 +25,4 @@ Example error response:
 ```
 
 ### Endpoint Overview
-::: api.endpoints.get_calendar
+::: api.endpoints.get_calendar
diff --git a/docs/endpoints/slack.md b/docs/endpoints/slack.md
@@ -0,0 +1,4 @@
+
+::: api.endpoints.get_announcement
+::: api.endpoints.slack_events
+::: api.endpoints.message_actions
diff --git a/docs/endpoints/slack_bot.md b/docs/endpoints/slack_bot.md
@@ -1,4 +1,4 @@
 
 
 ::: api.endpoints.slack_events
-::: api.endpoints.message_actions
+::: api.endpoints.message_actions
diff --git a/docs/endpoints/wikithoughts.md b/docs/endpoints/wikithoughts.md
@@ -18,4 +18,4 @@ In the event of an Error, the API will log an error and display default text
 }
 ```
 
-::: api.endpoints.wikithought
+::: api.endpoints.wikithought
diff --git a/docs/getting-started/getting-started.md b/docs/getting-started/getting-started.md
@@ -2,15 +2,15 @@
 ## Installing
 1. Clone and cd into the repo: git clone https://github.com/WeatherGod3218/jumpstartV2
 >> Make another branch if you are working on a large PR
-2. 
+2.
 
 ## Setup
 1. Make sure you have docker installed
 >> (OPTIONAL): You can use docker compose as well!!
 2. Copy the .env.template file, rename it to .env and place it in the root folder
 3. Ask an RTP for jumpstart secrets, add them to the .env accordingly
 
-## Run 
+## Run
 1. Build the docker file
 ```
     docker build -t Jumpstart .
@@ -23,4 +23,4 @@
 ### Alternatively, you can run the docker compose file as well
 ```
     docker compose up
-```
+```
diff --git a/docs/getting-started/setup.md b/docs/getting-started/setup.md
diff --git a/docs/index.md b/docs/index.md
@@ -5,10 +5,10 @@
 ![Static Badge](https://img.shields.io/badge/%40gravy-made_by?style=flat-square&logo=github&labelColor=%230d1117&color=%23E11C52&link=https%3A%2F%2Fgithub.com%2FNikolaiStrong)
 
 
-A graphical interface that displays information in the elevator lobby of Computer Science House. 
+A graphical interface that displays information in the elevator lobby of Computer Science House.
 All information displayed has been authorized to been shown.
 
-This project uses Python, [FastAPI](https://fastapi.tiangolo.com/), HTML/CSS, and Javascript. 
+This project uses Python, [FastAPI](https://fastapi.tiangolo.com/), HTML/CSS, and Javascript.
 See it live [here](http://jumpstart-squared.cs.house/)!
 
 The application has multiple features:
@@ -23,7 +23,7 @@ The application has multiple features:
  5. An informational that displays real-time status information from CSH’s server room.
 
  6. Calendar module that uses the Python ICalendar to display a countdown to the next 10 events from the CSH calendar.
- 
+
  7. Displays a daily forecast.
 
 ### AUTHORS:

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -3,4 +3,4 @@ mkdocstrings
 mkdocstrings-python
 mkdocs-minify-plugin
 mkdocs-git-revision-date-localized-plugin
-pymdown-extensions
+pymdown-extensions
diff --git a/docs/themes/how_to.md b/docs/themes/how_to.md
@@ -0,0 +1,22 @@
+Jumpstart has many different themes displayed on the website, this is a step by step process on how to implement your own!
+
+**Any images that need to be added should be put in src/static/img**
+
+### Adding Background
+
+1. Go to the file: **src/static/js/main.js**
+2. In the function long update, figure out the day, month, and hour of your theme.
+    - hour is in 24H format
+3. Add it into the if statement (please change this in the future)
+    - Make sure it follows the bgImage = "url(../static/img/{**YOUR FILE HERE**})"
+
+### Adding CSS Theme
+1. Go to the file **src/static/css/style.css**
+2. Add a new class for the colors **MAKE SURE IT STARTS WITH {theme-}!!!**
+3. Change the colors in this new class
+4. Repeat the steps in the "Adding Background"
+5. Add a new index into "allThemes" with your css theme, along with any changes to weatherwidget or datadog
+6. change the themeToLoad in the if statement to load your new index
+
+
+
diff --git a/docs/themes/overview.md b/docs/themes/overview.md
@@ -0,0 +1,30 @@
+Jumpstart has many different themes displayed on the website. Ranging from the light - dark mode, to full background and color shifts fo events. 
+
+### All Themes
+- Light Mode
+    - Default theme between 9 AM and 6 PM
+- Dark Mode
+    - Default theme between 6 PM and 9 AM
+- Valentine's Day
+    - Feburary 12th, 13th and 14th
+    - Changes title to "Constantly Smooching House"
+    - Adds decorative hearts around the logo
+- BANG!
+    - March 13th
+    - Changes title to "BANG! Science"
+    - Gives an orange gradient to the background
+- CSH 50th Anniversary
+    - April 9th, 10th, 11th, and 12
+    - Replaces title with the CSH 50th Anniversary logo
+    - Replaces color scheme with a Golden / Black theme
+- Halloween
+    - October 29th, 30th, and 31st
+    - Changes title to "Computer Spooky House"
+    - Logo is given orange and purple colors
+- Duck!
+    - November 2nd
+    - Duck
+- Winter
+    - November and December
+    - Changes title to "Christmas Season"
+    - Gives a red and green logo with a bright blue background
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -38,15 +38,17 @@ use_directory_urls: false
 nav:
   - Home: index.md
   - Getting Started: getting-started/getting-started.md
-  - Backend:
-      - Wikithoughts: core/Wiki-thoughts.md
-      - Calendar: core/CSH Calendar.md
-      - Slack: core/Slack.md
+  - Backend:      
+      - Calendar: core/csh_calendar.md
+      - Slack: core/slack.md
+      - Wikithoughts: core/wikithoughts.md
   - Endpoints:
-      - Calendar: endpoints/calendar_endpoint.md
-      - Announcements: endpoints/announcements.md
-      - Slack Bot: endpoints/slack_bot.md
-      - Wiki Thoughts: endpoints/wikithoughts.md
+      - Calendar: endpoints/csh_calendar.md
+      - Slack: endpoints/slack.md
+      - Wikithoughts: endpoints/wikithoughts.md
+  - Themes:
+      - Themes: themes/overview.md
+      - Adding Your Own: themes/how_to.md
 
 plugins:
   - search

diff --git a/pytest.ini b/pytest.ini
@@ -0,0 +1,4 @@
+[pytest]
+addopts = -ra
+python_files = test_*.py
+pythonpath = src
diff --git a/ruff.toml b/ruff.toml
@@ -10,4 +10,4 @@ line-length = 88
 [format]
 quote-style = "double"
 indent-style = "tab"
-skip-magic-trailing-comma = false
+skip-magic-trailing-comma = false
diff --git a/sonar-project.properties b/sonar-project.properties
@@ -1 +1,3 @@
-sonar.projectKey=jumpstart-v2
+sonar.projectKey=jumpstart-v2
+sonar.python.coverage.reportPaths=coverage.xml
+sonar.coverage.exclusions=**/tests/**,**/*test*.py,**/test_*.py
diff --git a/src/__init__.py b/src/__init__.py
@@ -1 +0,0 @@
-
Original file line number	Diff line number	Diff line change
Expand Up		@@ -21,4 +21,4 @@ RUN addgroup -g 2000 jumpgroup && adduser -S -u 1001 -G jumpgroup jumpstart && \

		USER jumpstart

		CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000", "--log-config", "/jumpstart/logging_config.yaml", "--proxy-headers","--forwarded-allow-ips","*"]
		CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000", "--log-config", "/jumpstart/logging_config.yaml", "--proxy-headers", "--forwarded-allow-ips", "*"]
Original file line number	Diff line number	Diff line change
		@@ -1,3 +1,3 @@


		::: api.endpoints.get_announcement
		::: api.endpoints.get_announcement
-Original file line number
+Diff line change
@@ Expand Up @@
     }
     ```
-    ::: api.endpoints.wikithought
+    ::: api.endpoints.wikithought