Skip to content

README.md

Latest commit

 

History

History
57 lines (39 loc) · 1.58 KB

README.md

File metadata and controls

57 lines (39 loc) · 1.58 KB
Raw

Suttama Gong

Multi-zone gong system for regular and parallel courses.

Development Environment

This project uses devenv to manage development environments, tasks, and processes. Instead of manually configuring Python and JavaScript environments, devenv provides a single unified solution.

To get started:

  1. Install devenv (recommended: use the Determinate Nix Installer)
  2. Run devenv shell to build and enter the development environment
  3. Optional, but recommended: Set up direnv for automatic shell activation

Getting Started

Inside the development environment:

  1. Install the dependencies:
deps:install

Note

  • This will install both web and rpi dependencies.
  • If you want to install only one project, cd into its directory and run its package manager install command:
    • uv sync for the RPi project
    • bun install for the web project
  1. Initialize the database:
devenv tasks run db:init
  1. Launch all services:
devenv up

See devenv.nix for detailed configuration.

Important

  • Use devenv up to run all servers from the root folder
  • To run a single server, cd into its directory and use the dev script:
    • rpi:dev for the RPi server
    • web:dev for the web server

Learn More