fitztrev / broadcaster

Development Setup

Prerequisites

1. Follow steps for installing Rust + Tauri here: https://tauri.app/v1/guides/getting-started/prerequisites
2. Install pnpm

    npm install -g pnpm

Run

pnpm install
pnpm tauri dev

Testing

Simulate boards writing PGN to a folder:

1. In the app, select a Round and start a folder watch.
2. Run this to automatically write a bunch of PGN to the folder:

pnpm esrun sample-data/generate/index.ts path/to/selected/folder

Formatting / Linting / Tests

pnpm format
pnpm tsc
pnpm test ## or pnpm test:watch

Icon Generation

Given a source image file, generate the icon files for the app:

pnpm tauri icon public/lichess-favicon-1024.png

Test Build

pnpm tauri build

Release artifacts are in src-tauri/target/release/bundle/

Release (for maintainers)

1. Tag the new version:

   git checkout main
   npm version 0.x.x
   git push origin main --tags

2. Github workflow will build the app for each OS, create a release, and attach the artifacts.