https://github.com/yeti-robotics/polar-edge
YETI Robotics' scouting site for 2025 and beyond
https://github.com/yeti-robotics/polar-edge
Last synced: about 2 months ago
JSON representation
YETI Robotics' scouting site for 2025 and beyond
- Host: GitHub
- URL: https://github.com/yeti-robotics/polar-edge
- Owner: Yeti-Robotics
- Created: 2024-06-18T23:43:44.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-11T00:03:14.000Z (about 1 year ago)
- Last Synced: 2025-06-11T01:19:15.596Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 5.87 MB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Polar Edge
## About
Polar Edge is a scouting application for _FIRST_ Robotics Competition, built by Team 3506, YETI Robotics.
## Setup
### Prerequisites
Polar Edge requires a local installation of [Node.js](https://nodejs.org/en/download/), and [Docker Desktop](https://www.docker.com/products/docker-desktop/)/[PostgreSQL](https://www.postgresql.org/download/) to run. We recommend using [nvm](https://github.com/nvm-sh/nvm) (MacOS/Linux) or [fnm](https://github.com/Schniz/fnm) (Windows) to manage your Node.js installation.
### Local Setup
Setting up Polar Edge requires running a local instance of the database, and building the application. If Docker Desktop is installed and running, this will be handled automatically on dev startup. Otherwise, you will need to start the database manually.
In the root directory, run `pnpm install` to install the dependencies for the entire project. We recommend also installing the `turbo` CLI globally to make running commands easier. This can be done by running `pnpm install -g turbo`.
Two `.env.local` files are required for the project to build: one for the Next.js frontend, and one for the database package.
- `apps/web/.env.local`: This file is used to configure the Next.js frontend. It should be copied from `apps/web/.env.example`.
- `packages/database/.env.local`: This file is used to configure the database. It should be copied from `packages/database/.env.example`.
> If you are not using Docker Desktop, ensure that the `DATABASE_URL` in `packages/database/.env.local` points to your local PostgreSQL instance.
Once the dependencies are installed and `.env.local` files are configured, you can start the development server by running `turbo dev`.
## Documentation
Documentation for the project can be found on the [YETI Robotics' Wiki](https://wiki.yetirobotics.org/books/polar-edge-analytics).