Creating your Development Setup

This guide discusses setting up the Polar Edge Analytics repository for local development.

Prerequisites

This guide assumes you have the following already set up (TODO: add references on how to get these configured)

• Node.js installed; we recommend using nvm (MacOS/Linux) or fnm (Windows) to manage your Node.js version
• pnpm installed
• Docker Desktop installed

Local Setup

Setting up the Polar Edge Analytics repository requires running a local instance of the database. We currently provide a shell script located at apps/web/lib/database/scripts/db-start.sh to do so, with plans to run this script automatically in the future.

If the root directory, run pnpm install to install dependencies across the entire repository. We recommend installing the turbo CLI globally to make running commands easier. This can be done by running pnpm i -g turbo.

For developing the scouting site, only one .env file is currently required. For convenience, we provide a .env.example file within the apps/web directory. Copy the contents of this file into another called .env.local.

 NOTE: this file is currently unavailable, it should be shortly...

Once dependencies are installed and the .env.local files are configured, the development server can be run via:

turbo dev # if turbo CLI installed globally
pnpm run dev # if turbo CLI not installed globally