README.md

Toolpad

Product walkthrough

• Toolpad Core is a set of high level React components that abstract common concepts such as layout navigation and routing. It aims at helping you build and maintain dashboards and internal tooling faster. It's built on top of Material UI.

toolpad_core_walkthrough.mp4

• Toolpad Studio is a self-hosted low-code admin builder designed to extend the Toolpad Core React components. It's for developers of all trades who want to save time building internal applications. Drag and drop from a catalog of pre-built components, connect to any data source and build apps quickly.

readme_video.mp4

Notice

Toolpad is in its beta stages of development. Feel free to run this application to try it out for your use cases, and share any feedback, bug reports or feature requests that you come across.

Quick setup locally

Toolpad Core:

npx create-toolpad-app@latest
# or
pnpm create toolpad-app
# or
yarn create toolpad-app

Toolpad Studio:

npx create-toolpad-app@latest --studio my-toolpad-studio-app
# or
yarn create toolpad-app --studio my-toolpad-studio-app
# or
pnpm create toolpad-app --studio my-toolpad-studio-app

Documentation

Check out our documentation.

Examples

Core

Find a list of example apps on the docs to help you get started with Toolpad Core quickly.

Studio

Check out our mui-public app to see how a Toolpad Studio app looks in production. Our documentation contains more examples to help you get started.

Contributing

Read the contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to MUI.

Notice that contributions go far beyond pull requests and commits. Although we love giving you the opportunity to put your stamp on MUI, we also are thrilled to receive a variety of other contributions.

Changelog

The changelog is regularly updated to reflect what's changed in each new release.

Roadmap

Future plans and high-priority features and enhancements can be found in the roadmap.

License

This project is licensed under the terms of the MIT license.

Sponsoring services

These great services sponsor MUI's core infrastructure:

GitHub allows us to host the Git repository and coordinate contributions.

Netlify allows us to distribute the documentation.

BrowserStack allows us to test in real browsers.

CodeCov allows us to monitor the test coverage.