Getting Started
April 3, 2026 · View on GitHub
New to WallRun? Start here to understand the project's purpose, structure, and philosophy.
Documents in this Section
Statement of Intent
Sets the tone: digital signage treated as software, with a particular focus on BrightSign devices and always-on, unattended constraints.
Key Topics: programmable signage, offline constraints, failure modes, physical context
Why a React SPA Boilerplate?
Explains why a React Single-Page Application (SPA) is a strong default for signage tooling: determinism, offline-first behavior, and fewer moving pieces than SSR.
Key Topics: signage constraints, offline-first, deterministic layouts, SPA vs SSR
Understanding the Project Structure
Overview of the monorepo architecture, Nx workspace organization, and how apps and libraries are structured.
Key Topics: Nx monorepo, apps vs libs, folder structure, dependency graph
Project Goals
Detailed breakdown of the project's objectives, target audience, and guiding principles.
Key Topics: signage-first goals, deterministic UI, developer experience, BrightSign-focused exploration
AI-Assisted Feature Workflow
A step-by-step guide to implementing features using our "6 Pillars" AI tooling architecture. Learn how to mix Agents, Skills, and Prompts to work faster.
Key Topics: @requirements-planner, pnpm verify, 6 Pillars, Agents vs Prompts
Next Steps
After understanding the basics:
- Build Something: See Guides for hands-on tutorials
- Configure Tooling: Check Tooling for productivity enhancements
- Contribute: Review Contributing guidelines