How mui/toolpad works
Project type and purpose
• This is a monorepo for “Toolpad,” a low-code dashboard builder.
• Toolpad Core: A React component library for dashboards (packages/toolpad-core).
• Toolpad Studio: A self-hosted low-code UI editor (packages/toolpad-studio) plus its runtime (packages/toolpad-studio-runtime and packages/toolpad-studio-components).
• CLI scaffolding: create-toolpad-app (packages/create-toolpad-app) to bootstrap new Toolpad projects.
• Utility libraries: toolpad-utils.
• Examples, playgrounds, docs (docs/ and examples/).
• CI/CD and build scripts for testing, linting, publishing.
File structure analysis
• Monorepo root: pnpm-workspace, lerna.json, scripts/, .github/ and .circleci/ define CI workflows.
• packages/: each package encapsulates a distinct component (Core, Studio, CLI, Utils, etc.).
• docs/: Next.js-based documentation site.
• examples/ & playground/: sample Toolpad apps demonstrating usage.
• scripts/: custom build and release orchestration.
• test/: integration & visual test fixtures.
Key README insights
• “Toolpad Core” for React dashboards.
• “Toolpad Studio” low-code builder with drag-drop, built on Toolpad Core.
• CLI commands generate Core or Studio projects.
• Documentation and examples are hosted via Next.js/docs.
a. Main components
• Monorepo Orchestrator: pnpm/Lerna, root-level scripts, CI pipelines.
• CLI Scaffolder: create-toolpad-app (template engine, project generator).
• Toolpad Core Library: React components, theming, routing abstractions.
• Toolpad Studio Frontend: React-based low-code editor UI.
• Toolpad Studio Server: Node.js server providing data sources, function runtimes, project RPC.
• Studio Runtime: Browser/runtime engine for running published Toolpad apps.
• Studio Components Package: Pre-built UI elements for Studio and runtime.
• Utility Library: toolpad-utils (shared hooks, HTTP adapters, file utilities).
• Documentation Site: Next.js app under docs/.
• Example Apps & Playground: sample Next.js/Vite projects for reference.
b. Relationships and interactions
• CLI → generates new project using Core or Studio templates.
• Generated apps → import Toolpad Core (UI), Studio Runtime (if low-code), and Utils.
• Studio Frontend ↔ Studio Server over HTTP/RPC for project editing.
• Studio Server → manages DataManager, FunctionsManager, EnvManager, Vite virtual modules.
• Studio Runtime (in user projects) → executes functions, queries, and renders pages.
• Documentation Site → imports docs data and compiles examples.
• CI/CD pipelines → run lint/test/build for all packages and publish to npm.
c. Architectural patterns and design principles
• Monorepo modularization: each package is isolated, with explicit dependencies.
• Package templates & code generation (CLI).
• Client-Server separation in Studio: Editor UI vs. backend project runner.
• Library vs. Application: Core & Utils are libraries; Studio is an application with frontend and backend.
• Micro-frontend feel: Studio Runtime runs inside scaffolded apps.
• Standard web patterns: Next.js for docs, React for UI, Vite for dev.
d. Relevant technologies
• Package management: pnpm, Lerna.
• Build/test: TypeScript, tsup, Vitest, Playwright.
• UI: React, Material-UI.
• Server: Node.js, Express/RPC.
• Docs: Next.js, markdown.
• CI: GitHub Actions, CircleCI.