frc-emotion / nautilus-backend

Backend Scouting and Attendance solution for FIRST Robotics Competition teams.
0 stars 0 forks source link

Nautilus Backend

[!WARNING] Nautilus is currently in early stage development. Features may be missing and backwards compatibility is not guaranteed in future versions.

Nautilus is a mobile native scouting and attendance solution for FIRST Robotics Competition teams.

Getting Started

[!NOTE] Temporary section, replace later in proper documentation

Important note before we begin: Ensure you have a proper understanding of Git and its development pipeline before contributing to any repository. This is a great introductory video.

Install these:

Main dependencies: Python 3.13, Pip, Visual Studio Code, Git

Once you have everything installed, clone the repository by running:

git clone https://github.com/frc-emotion/nautilus-backend.git

You may be prompted to enter authentication details. For this, you may need to generate a Personal Access Token to use as your GitHub Password. See here if you need instructions.

Once the repository is successfully cloned onto your machine, install all necessary dependencies by running:

pip install -r requirements.txt

After you have completed these steps, your development environment should be fully set up, making you ready for development and writing your first contribution.