Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 2.84 KB

README.md

File metadata and controls

26 lines (18 loc) · 2.84 KB
Raw

1678 Server 2024 (Public)

pytest lint

Welcome to the public repository for Team 1678 Software Scouting's Server! Feel free to check out our 2024 Scouting Whitepaper and the 2024 public Software Scouting repositories for our Match Collection, Viewer, Server, Schema, Stand Strategist, Pit Collection, OverRate, and Pit Display apps.

Setting Up a Server Clone

For a full in-depth guide, please view this document.

  1. To set up the schema submodule, run git submodule init, and then git submodule update.

  2. Run src/setup_environment.py when you clone the repository. This will install a virtual environment in the main project directory. It will then install the external dependencies into this environment from PyPI using pip. (This will NOT install any non-python dependencies such as MongoDB and Android Debug Bridge as that process depends on your distribution. You will have to do that manually).

    • Debian-based systems do not install venv or pip with python by default; use sudo apt install to install python3.8, python3-venv and python3-pip.

    • There is also a directory called data/ that needs specific files like competition.txt and a directory called api_keys/ which contains tba_key.txt and cloud_password.txt. The competition.txt file is created by src/setup_competition.py and the two keys need to be added manually.

    • When testing from the command line, remember to activate the virtual environment (source .venv/bin/activate on bash/zsh). Instructions for other shells, along with more in-depth information about Python virtual environments, can be found here. Note: currently, only Linux and MacOS operating systems are supported. For Windows computers, please use WSL to work with server.

Running Server

To run the server in production mode on Linux or MacOS make sure to run export SCOUTING_SERVER_ENV=production. To take the server out of production mode, run unset SCOUTING_SERVER_ENV