How madhank93/build-your-own-x works
byox is a local CodeCrafters course runner: a learner selects a course and stage in the TUI, runs the official tester against their solution, and records passing progress so later stages unlock. The repository also includes course registration and validation, learning notes, reference solutions, and a generated web catalog. The README documents the main workflow; sampled source confirms the catalog generator’s inputs. Several engine and course subsystems are represented from the tree and README rather than inspected source, so their internal links are omitted where evidence is unavailable.
Main entry points: tui.go Interactive TUI · run.go Test runner · main.go Catalog generator · progress.go Stage progress
Components 21
Local runner
- byox CLI
engine/cmd/byox/main.go - Interactive TUI
engine/internal/tui/tui.go - TUI views
engine/internal/tui/overlay.go - Test log buffer
engine/internal/tui/logbuf.go - Watch mode
engine/internal/tui/watch.go - TUI help
engine/internal/tui/help.go - Test runner
engine/internal/runner/run.go - Course setup
engine/internal/runner/setup.go - Stage progress
engine/internal/progress/progress.go - Stage diff
engine/diff/diff.go
Course content
- Course registry
engine/course/registry.go - Course definition
engine/course/definition.go - Course validation
engine/course/validate.go - Stage instructions
- Learning notes
learn
Solutions
- Learner solutions
solutions - Reference solutions
reference-solutions
Web catalog
- Catalog generator
web/gen/main.go - Web catalog
web/src/pages/catalog-details/[slug].json.ts
Other components
- Learner
- Official tester
Connections 15
- Learner → Interactive TUI: selects stage
- Learner → Learner solutions: edits code
- Interactive TUI → Test runner: runs tests
- Watch mode → Test runner: reruns tests
- Test runner → Learner solutions: tests code
- Test runner → Official tester: invokes tester
- Test runner → Stage progress: records passes
- Interactive TUI → Stage progress: shows progress
- Interactive TUI → Stage instructions: renders instructions
- Interactive TUI → Learning notes: shows notes
- Interactive TUI → Reference solutions: shows solution
- Catalog generator → Reference solutions: reads snapshots
web/gen/main.go - Catalog generator → Learning notes: reads notes
web/gen/main.go - Catalog generator → Web catalog: generates catalog data
web/gen/main.go - Learner → Web catalog: browses stages