-
-
Notifications
You must be signed in to change notification settings - Fork 274
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b665b97
commit cd4b546
Showing
2 changed files
with
31 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,37 @@ | ||
# @toolpad/studio | ||
<!-- markdownlint-disable-next-line --> | ||
<p align="center"> | ||
<a href="https://mui.com/toolpad/" rel="noopener" target="_blank"><img width="150" src="https://mui.com/static/branding/product-toolpad-light.svg" alt="Toolpad Studio logo"></a> | ||
</p> | ||
|
||
Low-code tool, powered by MUI | ||
<h1 align="center">Toolpad Studio</h1> | ||
|
||
Toolpad Studio is a self-hosted low-code admin builder designed to extend the [MUI](https://mui.com/) React components. It's for developers of all trades who want to save time building internal applications. Drag-and-drop from a catalogue of pre-built components, connect to any data source and build apps quickly. | ||
|
||
## Installation | ||
|
||
Install the package in your project directory with: | ||
|
||
```bash | ||
npm install @toolpad/studio | ||
npx create-toolpad-app@latest my-toolpad-studio-app | ||
# or | ||
yarn create toolpad-app my-toolpad-studio-app | ||
# or | ||
pnpm create toolpad-app my-toolpad-studio-app | ||
``` | ||
|
||
## Documentation | ||
|
||
[The documentation](./docs) | ||
Visit [https://mui.com/toolpad/studio/getting-started/](https://mui.com/toolpad/studio/getting-started/) to view the full documentation. | ||
|
||
## Examples | ||
|
||
Check out our [mui-public](https://tools-public.onrender.com/prod/pages/OverviewPage) app to see how a Toolpad Studio app looks in production. | ||
Our documentation contains more [examples](https://mui.com/toolpad/studio/examples/) to help you get started. | ||
|
||
## Changelog | ||
|
||
The [changelog](https://github.com/mui/mui-toolpad/releases) 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](https://mui.com/toolpad/studio/getting-started/roadmap/). |