Tutorials

Learning paths: run a complete MDK site, build your own endpoint and dashboard, or generate one with an agent

New to MDK? See it run first

These are not a sequence. Run the finished site to see the whole stack, then build your own version of it when you want your own data on your own routes.

Run a mining site end to end

Run the full example: Workers, mock hardware, a Gateway API, an MCP server, and a live dashboard from one command

Build a minimal single-page dashboard

Build from an empty directory: one Worker, one Gateway route, and one React page

Build a dashboard with an agent

Generate it instead: wire Cursor or Claude once, then build from plain-language prompts

The Gateway serves only the routes its plugins provide, so getting Worker telemetry to a browser means mounting your own endpoint. Building a dashboard covers that end to end, and building a Gateway plugin is the reference for writing your own.

Next steps

Learn more about the high-level architecture: runtime stack and deployment modes
Install and wire the React packages: the provider, hooks, and theming
Integrate your own hardware by building a third-party Worker
Run a site from the deployment guides
Contribute