Skip to main content

Environment Setup

Prepare your local machine to contribute to the project. You can configure your environment automatically using Nix (recommended) or manually install the required dependencies.

We recommend using devenv and direnv to create an isolated development environment. This method automatically installs and configures the correct tool versions when you enter the project directory.

  1. Set up the Nix package manager and devenv by following the installation guide.
  2. Install direnv and hook it into your shell to enable automatic environment switching.
tip

Use Starship to display your active devenv status directly in your terminal prompt.

Manual Setup​

If you prefer to manage your environment yourself, install the following dependencies globally. You must use the specified versions to avoid compatibility issues.

  • Git LFS: Required for handling large media assets. Make sure to run git lfs pull in the repo.
  • Node.js: Version 24.x
  • Build Tools: gcc, ffmpeg, yarn, sqlite