Welcome to the Excalidraw project! This guide will help you get productive quickly.
| # | Document | What You'll Learn |
|---|---|---|
| 1 | Architecture Overview | Monorepo structure, package responsibilities, how components interact |
| 2 | Local Setup | Prerequisites, installation, running the app, environment variables |
| 3 | Codebase Navigation | Folder structure, where to find things, naming conventions |
| 4 | Key Business Flows | Drawing, collaboration, save/load, export, undo/redo |
| 5 | Important Components | Core classes, managers, event handlers, integration services |
| 6 | Testing Guide | Test structure, running tests, mocking strategy, writing new tests |
| 7 | Common Pitfalls | Race conditions, data consistency, things that break production |
| 8 | Adding New Features | Patterns to follow, where to add logic, what to avoid |
| 9 | TL;DR for New Developers | Day-1 checklist, key commands, files to read first |
There is also a printable combined version:
- new-employee-guide.html — styled HTML combining key content, optimized for printing/PDF export
Day 1: Start with the TL;DR, then follow the Local Setup.
Day 2–3: Read the Architecture Overview and Codebase Navigation.
First week: Study the Key Business Flows and Important Components.
Before your first PR: Read the Testing Guide, Common Pitfalls, and Adding New Features.