Quickstart
Pick the door that matches what you have and what you want to build with MDK
Start here
Run a mining site
You want to see MDK working. One command brings up Workers, mock hardware, a Gateway API, and a live browser dashboard⏱️ <5 min, ends in a dashboard
Build your own endpoint and dashboard
You want MDK telemetry in your own app. Build one Worker, one Gateway route, and one React page from an empty directory⏱️ ~15 min, ends in your own plugin and page
Build a Worker
Your hardware, firmware, or data feed is not supported yet. Ship a Worker package from your own repo, no monorepo fork neededEnds in a Worker package
Build with an AI agent
You drive Cursor or Claude. Wire your IDE once, then build dashboards from plain-language prompts⏱️ ~12 min, ends in a scaffolded page
Other starting points
Wire an existing React app
You already have a React app and want to hand-wire MDK into it rather than generate pages⏱️ ~3 min to install
Deploy a site
You know what you are shipping and need a topology: one process, supervised services, or the full Worker fleetEnds in a running deployment
Next steps
- Understand how the pieces fit together: the runtime stack and its deployment modes
- Learn the vocabulary: Kernel, Worker, Gateway, manager, and thing
- Browse every runnable example: what each one demonstrates and how to start it