Skip to content

Team334/Castle

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ee3ab90 · Mar 20, 2025
Mar 17, 2025
Mar 20, 2025
Jan 31, 2025
Mar 18, 2025
Jan 9, 2025
Feb 27, 2025
Mar 17, 2025
Feb 15, 2025
Mar 16, 2025
Nov 19, 2024
Mar 16, 2025
Mar 16, 2025
Mar 10, 2025
Mar 17, 2025

Repository files navigation

Castle

The Official Scouting App Presented By Team 334

video.mp4

Prerequisite

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:

MongoDB Compass

  1. 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:your-email@example.com

To generate VAPID keys, read here: https://github.com/web-push-libs/vapid/blob/main/python/README.md

  1. 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
  2. Run the app through (in parent directory outside of app): python -m app