-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
17092a6
commit 1b9498a
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
[![ProjectHUD CI](https://github.com/FRC-1721/ProjectHud/actions/workflows/build_docker.yml/badge.svg)](https://github.com/FRC-1721/ProjectHud/actions/workflows/build_docker.yml) | ||
|
||
# Project Hud | ||
|
||
Flask server for displaying a quick development HUD (built specifically for use with FRC1721's code environment. | ||
|
||
![image](https://github.com/user-attachments/assets/4e62c869-bbb0-4391-9818-1196055490b4) | ||
|
||
## Development | ||
|
||
```shell | ||
pipenv shell | ||
flask run --debug | ||
``` | ||
|
||
## Deploy | ||
|
||
Deployment is handled with docker. | ||
|
||
```yaml | ||
# Example Docker Compose File | ||
|
||
services: | ||
project_hud: | ||
image: ghcr.io/frc-1721/project_hud-bot:main | ||
environment: | ||
TZ: America/New_York | ||
GITHUB_TOKEN: YOUR_TOKEN | ||
GITHUB_REPOS: YOUR,REPOS | ||
``` | ||