Danilo Reyes
2f096d0265
- Introduced export schema for JSON data structure. - Created renderer contract detailing canvas/SVG rendering requirements. - Defined IndexedDB storage schema and migration strategies. - Documented data model including entities and relationships. - Developed implementation plan outlining execution flow and project structure. - Provided quickstart guide for development environment setup. - Compiled research documentation on performance, accessibility, and theming. - Established feature specification with user scenarios and functional requirements.
36 lines
718 B
Markdown
36 lines
718 B
Markdown
# Quickstart — GlowTrack
|
|
|
|
## Prerequisites
|
|
- Nix installed (flakes enabled)
|
|
|
|
## Dev Environment
|
|
- Enter dev shell:
|
|
- nix develop
|
|
- Install JS deps (first time):
|
|
- pnpm install
|
|
- Run typecheck and lints:
|
|
- pnpm run svelte-check
|
|
- pnpm run lint
|
|
|
|
## Run App (dev)
|
|
- Start web app:
|
|
- pnpm run dev
|
|
- Open in browser (URL printed by dev server)
|
|
|
|
## Build (static site)
|
|
- Build via Nix flake:
|
|
- nix build .#app
|
|
- Or via pnpm:
|
|
- pnpm run build
|
|
|
|
## Tests
|
|
- Unit tests:
|
|
- pnpm run test
|
|
- E2E smoke (headed/CI):
|
|
- pnpm run test:e2e
|
|
|
|
## Export/Import
|
|
- Export JSON (in-app): Settings → Export → JSON
|
|
- Import JSON: Settings → Import → select file
|
|
- Export PNG: Share/Export → PNG (screen resolution)
|