https://github.com/team334/castle
Scouting App for Team 334
https://github.com/team334/castle
app flask frc mongodb python scouting-app
Last synced: 28 days ago
JSON representation
Scouting App for Team 334
- Host: GitHub
- URL: https://github.com/team334/castle
- Owner: Team334
- License: mit
- Created: 2024-11-13T23:05:11.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-04-08T15:36:28.000Z (about 2 months ago)
- Last Synced: 2025-04-30T10:16:30.622Z (about 1 month ago)
- Topics: app, flask, frc, mongodb, python, scouting-app
- Language: HTML
- Homepage: https://castlescouting.com
- Size: 8.84 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.yml
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Castle
> The Official Scouting App Presented By Team 334
https://github.com/user-attachments/assets/09c607ce-628d-41e6-ab82-b5fb1a4ec928
## Prerequisite
- [MongoDB compass](https://www.mongodb.com/try/download/community) - https://www.mongodb.com/try/download/community
- [Python](https://python.org) - https://python.org
## How to install
> Raspberry PI Local Install https://docs.google.com/document/d/1M9b2T-DrkaLq0EBT1hQqs_XhuhEjtLw3hJQsBVWiQsk/edit?usp=sharing
1. Clone the repo: `git clone https://github.com/team334/Castle`
2. Create a database in [MongoDB compass](https://www.mongodb.com/try/download/community):
3. Create `.env` file in root directory, should look similar to this
```
SECRET_KEY=your_secret_key
MONGO_URI=mongodb://localhost:27017/scouting_app
TBA_AUTH_KEY=your_tba_api_key
DEBUG=False
HOST=localhost
PORT=5000
VAPID_PUBLIC_KEY=your_vapid_public_key
VAPID_PRIVATE_KEY=your_vapid_private_key
VAPID_CLAIM_EMAIL=mailto:[email protected]
```
> To generate VAPID keys, read here: https://github.com/web-push-libs/vapid/blob/main/python/README.md
4. Set up the environment and install dependencies:
### Using installation scripts (new)
#### Windows:
```
install.bat
```
#### Linux/macOS:
```
chmod +x install.sh
./install.sh
```
### Manual setup
- Make a virtual environment: `python -m venv venv`
- To activate (type into command line):
- Windows:
- Cmd: `venv\Scripts\activate`
- Powershell: `venv\Scripts\Activate.ps1`
- MacOS & Linux: `source ./venv/bin/activate`
- Install the dependencies: `pip install -r requirements.txt`
5. Run the app through (in parent directory outside of app): `python -m app`