Skip to content

Remove Toolpad Studio #4987

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 0 additions & 6 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,5 @@ dist
.coverage
.tsup

# deprecated Toolpad Studio:
test
/packages/toolpad-studio/
/packages/toolpad-studio-runtime/
/packages/toolpad-studio-components/

# generated TanStack Router files
routeTree.gen.ts
46 changes: 0 additions & 46 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -86,19 +86,6 @@ module.exports = {
ignore: ['\\.md\\?muiMarkdown$'],
},
],
'import/no-restricted-paths': [
'error',
{
zones: [
{
// Don't leak the internal runtime abstraction. It's on its way to be moved towards a separate package
target: './packages/toolpad-studio/src/runtime',
from: './packages/toolpad-studio/src/',
except: ['./runtime'],
},
],
},
],
'material-ui/no-hardcoded-labels': 'off', // We are not really translating the docs/website anymore
'react-compiler/react-compiler': 'error',
'material-ui/disallow-react-api-in-server-components': 'off',
Expand Down Expand Up @@ -144,9 +131,6 @@ module.exports = {
files: [
'packages/create-toolpad-app/**/*',
'packages/toolpad-core/**/*',
'packages/toolpad-studio/**/*',
'packages/toolpad-studio-components/**/*',
'packages/toolpad-studio-runtime/**/*',
'packages/toolpad-utils/**/*',
],
excludedFiles: [
Expand All @@ -162,54 +146,24 @@ module.exports = {
'import/no-extraneous-dependencies': ['error'],
},
},
{
files: [
/**
* Basically all code that is guaranteed being bundled for the client side and never used on serverside code
* can be dev dependencies to reduce the size of the published package
*/
'packages/toolpad-studio/src/components/**/*',
'packages/toolpad-studio/src/toolpad/**/*',
'packages/toolpad-studio/src/runtime/**/*',
],
excludedFiles: ['*.spec.ts', '*.spec.tsx'],
rules: {
'import/no-extraneous-dependencies': ['error', { devDependencies: true }],
},
},
{
// Starting small, we will progressively expand this to more packages.
files: [
// 'packages/create-toolpad-app/**/*',
// 'packages/toolpad-core/**/*',
// 'packages/toolpad-studio/**/*',
// 'packages/toolpad-studio/**/*',
'packages/toolpad-utils/**/*',
// 'packages/toolpad-studio-runtime/**/*',
// 'packages/toolpad-studio-components/**/*',
],
rules: {
'@typescript-eslint/no-explicit-any': ['error'],
},
},
{
files: ['packages/toolpad-studio/pages/**/*'],
rules: {
// The pattern is useful to type Next.js pages
'react/function-component-definition': 'off',
},
},
// TODO remove, fix this rule in the codebase
{
files: ['**'],
rules: {
'no-restricted-imports': ['error', noRestrictedImports],
},
},
{
files: ['packages/toolpad-studio/src/**/*'],
rules: { 'react-compiler/react-compiler': 'off' },
},
{
files: ['docs/**/*{.ts,.tsx,.js}'],
rules: {
Expand Down
6 changes: 0 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,6 @@ lerna-debug.log
dist/
build/

# studio
packages/toolpad-studio/public/web_modules
packages/toolpad-studio/public/runtime
packages/toolpad-studio/public/typings.json
.toolpad-generated

# examples
examples/*/*/yarn.lock

Expand Down
47 changes: 21 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,22 +25,16 @@

## Product walkthrough

- [Toolpad Core](https://mui.com/toolpad/core/introduction/) 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](http://github.com/mui/material-ui/).
[Toolpad Core](https://mui.com/toolpad/core/introduction/) 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](http://github.com/mui/material-ui/).

https://github.com/user-attachments/assets/d2a7ff8e-2dd6-4313-98d2-5f136513f9a9/

- [Toolpad Studio](https://mui.com/toolpad/studio/getting-started/) 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.

https://github.com/user-attachments/assets/f47466df-3790-4a05-8f38-f1aaa13a49f3/

## 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:

```bash
npx create-toolpad-app@latest
# or
Expand All @@ -49,31 +43,14 @@ pnpm create toolpad-app
yarn create toolpad-app
```

Toolpad Studio:

```bash
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](https://mui.com/toolpad/studio/getting-started/).
Check out our [documentation](https://mui.com/toolpad/core/introduction/).

## Examples

### Core

Find a [list of example apps](https://mui.com/toolpad/core/introduction/examples/) on the docs to help you get started with Toolpad Core quickly.

### Studio

Check out our [mui-public](https://tools-public.mui.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.

## Contributing

Read the [contributing guide](/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to MUI.
Expand All @@ -87,7 +64,25 @@ The [changelog](https://github.com/mui/toolpad/releases) is regularly updated to

## Roadmap

Future plans and high-priority features and enhancements can be found in the [roadmap](https://mui.com/toolpad/studio/getting-started/roadmap/).
Future plans and high-priority features and enhancements can be found in the [roadmap](https://mui.com/toolpad/core/introduction/roadmap/).

## Toolpad Studio

[Toolpad Studio](https://mui.com/toolpad/studio/getting-started/) 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.

https://github.com/user-attachments/assets/f47466df-3790-4a05-8f38-f1aaa13a49f3/

**Toolpad Studio has been deprecated**, but the project can be found in the [`toolpad-studio`](https://github.com/mui/toolpad/tree/toolpad-studio) branch of this repository, where it can also be published from.

The `create-toolpad-app` CLI can also still be used to quickly setup Toolpad Studio projects:

```bash
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
```

## License

Expand Down
28 changes: 6 additions & 22 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,6 @@
- Commit message (#pr-number) @author
- ...

### `@toolpad/studio`

- Commit message (#pr-number) @author
- ...

### Docs

- Commit message (#pr-number) @author
Expand Down Expand Up @@ -76,17 +71,6 @@

And verify the app runs

b. Run Toolpad Studio

```bash
pnpm dlx https://pkg.csb.dev/mui/toolpad/commit/<build>/create-toolpad-app --studio smoke
cd smoke
pnpm add https://pkg.csb.dev/mui/toolpad/commit/<build>/@toolpad/studio -S
pnpm dedupe && pnpm dev
```

And verify the editor works

1. Merge the PR changes, then check out the `master` branch and pull the last commit.

1. Publish the package to `npm`
Expand All @@ -97,7 +81,7 @@
npm login
```

1. Publish to `npm`
2. Publish to `npm`

```bash
pnpm release:publish
Expand All @@ -120,8 +104,8 @@
1. [Create a new GitHub release](https://github.com/mui/toolpad/releases/new).

1. Use `<version number>` to **Choose a tag** (when you enter new version GH UI will pop a suggestion `Create new tag: *** on publish`)
1. Use `<commit of merged PR>` as the **target**
1. Use the cleaned changelog as the content of **Describe this release**
1. Use `<version number>` as the **Release title**
1. Mark as prerelease if necessary.
1. **Publish release**
2. Use `<commit of merged PR>` as the **target**
3. Use the cleaned changelog as the content of **Describe this release**
4. Use `<version number>` as the **Release title**
5. Mark as prerelease if necessary.
6. **Publish release**
4 changes: 0 additions & 4 deletions codecov.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
coverage:
ignore:
- '*/icons/*'
# deprecated Toolpad Studio:
- 'packages/toolpad-studio/*'
- 'packages/toolpad-studio-runtime/*'
- 'packages/toolpad-studio-components/*'
status:
project:
default:
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ yarn && yarn docs:dev

If you do not have yarn installed, select your OS and follow the instructions on the pnpm. DO NOT USE npm, use pnpm to install the dependencies.

Visit the [Toolpad documentation](https://mui.com/toolpad/studio/getting-started/).
Visit the [Toolpad documentation](https://mui.com/toolpad/core/introduction/).

## How can I add a new demo to the documentation?

Expand Down
3 changes: 1 addition & 2 deletions docs/next.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ function loadPkg(pkgPath: string): { version: string } {
}

const toolpadCorePkg = loadPkg('./packages/toolpad-core');
const toolpadStudioPkg = loadPkg('./packages/toolpad-studio');

export default withDocsInfra({
experimental: {
Expand Down Expand Up @@ -55,7 +54,7 @@ export default withDocsInfra({
// Toolpad related
// …
TOOLPAD_CORE_VERSION: toolpadCorePkg.version,
TOOLPAD_STUDIO_VERSION: toolpadStudioPkg.version,
TOOLPAD_STUDIO_VERSION: '0.13.0',
},
webpack: (config, options) => {
return {
Expand Down
6 changes: 0 additions & 6 deletions eslintWebpackResolverConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,8 @@ module.exports = {
__dirname,
'./node_modules/@mui/monorepo/packages/api-docs-builder',
),
'@toolpad/studio-components': path.resolve(
__dirname,
'./packages/toolpad-studio-components/src',
),
'@toolpad/studio-runtime': path.resolve(__dirname, './packages/toolpad-studio-runtime/src'),
'@toolpad/utils': path.resolve(__dirname, './packages/toolpad-utils/src'),
'@toolpad/core': path.resolve(__dirname, './packages/toolpad-core/src'),
'@toolpad/studio-tests': path.resolve(__dirname, './test'),
docs: path.resolve(__dirname, './node_modules/@mui/monorepo/docs'),
'docs-toolpad': path.resolve(__dirname, './docs'),
},
Expand Down
4 changes: 0 additions & 4 deletions examples/studio/auth-github/.env.example

This file was deleted.

35 changes: 0 additions & 35 deletions examples/studio/auth-github/README.md

This file was deleted.

13 changes: 0 additions & 13 deletions examples/studio/auth-github/package.json

This file was deleted.

1 change: 0 additions & 1 deletion examples/studio/auth-github/toolpad/.gitignore

This file was deleted.

6 changes: 0 additions & 6 deletions examples/studio/auth-github/toolpad/application.yml

This file was deleted.

14 changes: 0 additions & 14 deletions examples/studio/auth-github/toolpad/pages/protectedpage/page.yml

This file was deleted.

4 changes: 0 additions & 4 deletions examples/studio/auth-google/.env.example

This file was deleted.

Loading
Loading