Skip to content

Latest commit

 

History

History

README.md

StreamGRID Documentation

Full documentation index for the StreamGRID project.

Start here

Reference

  • ARCHITECTURE.md — Electron multi-process architecture, component tree, data flow, IPC patterns
  • API.md — IPC channels, preload API, type definitions
  • TECHSTACK.md — Full dependency list with versions
  • DEVELOPMENT.md — Dev environment setup, build commands, testing
  • BUILD_COMPILE.md — Build system, platform packaging, electron-builder config

Operations

Project

  • PRD.md — Product requirements, goals, non-goals, scope
  • TODO.md — Known issues, planned features, tech debt
  • LEARNINGS.md — Gotchas and things that didn't work
  • DEPLOYMENT.md — Release procedures

Root-level files

These files live at the repository root:

Full index

Complete documentation file listing with descriptions:

File Purpose
PRD.md Product requirements document
ARCHITECTURE.md Electron multi-process architecture, component tree, data flow, security
API.md IPC channel reference, preload API, type definitions
TECHSTACK.md Full dependency list with exact versions
INSTALLATION.md Installation, prerequisites, config file locations
QUICK_START.md Get running in minimal steps
DEVELOPMENT.md Dev environment setup, build commands, testing, debugging
BUILD_COMPILE.md Build system, packaging, electron-builder config
DEPLOYMENT.md Release process, distribution targets, platform install notes
WORKFLOW.md Branching strategy, commit format, CI pipeline, release process
TROUBLESHOOTING.md Common issues and solutions
FAQ.md Frequently asked questions
TODO.md Known issues, planned features, technical debt
LEARNINGS.md Project retrospective and lessons learned

Reading order by audience

New users

README.md → QUICK_START.md → INSTALLATION.md → FAQ.md

Developers

DEVELOPMENT.md → ARCHITECTURE.md → API.md → CONTRIBUTING.md

Building / packaging

BUILD_COMPILE.md → DEPLOYMENT.md → WORKFLOW.md

Contributing

CONTRIBUTING.md (root) → DEVELOPMENT.md → ARCHITECTURE.md → API.md


Quick command reference

Command Purpose
npm run dev Development mode (Vite port 52774 + Electron)
npm run build Compile TypeScript + Vite bundle
npm run dist:linux AppImage, DEB, RPM, Snap
npm run dist:mac DMG (x64 + arm64)
npm run dist:win NSIS installer, MSI, ZIP
npm test Run Vitest
npm run lint ESLint
npm run type-check TypeScript strict — zero errors
./run-source-linux.sh Linux dev with sandbox fix