Build with FreeMoCap
Developer documentation for the freemocap core repository: how the
app is put together, how it fits into the wider polyrepo, and how
to build, test, and contribute to it. If you're looking for a specific
sibling repo's own documentation (SkellyCam, SkellyTracker, and so on),
start at the developer docs homepage instead, this section is
specifically about the freemocap app itself.
Architecture
- Architecture overview: the FastAPI backend, the React/Electron frontend, and how they connect. Start here.
- backend architecture: pub/sub, the websocket server, calibration, and triangulation.
- frontend architecture: providers, routing, state management, and styling.
- Follow one recording end to end: realtime and posthoc pipeline topology, from camera to frontend, or video to disk.
- The polyrepo map: the data-contract pipeline across
repos, generated from
data/repos.yml. - Data contracts between components: the reference table behind that map.
- All repositories: every repo in the polyrepo, including the utility tier.
Contributing
Design proposals
- Design proposals: in-progress design work, part of which has already landed in the current code; the linked page tracks exactly what is built versus still proposed.