Skip to content
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

Rename MUI Toolpad to Toolpad Studio #3238

Merged
merged 45 commits into from
Mar 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
b8bb879
Try to do renaming properly this time
apedroferreira Feb 28, 2024
d86a090
What an absolute mess
apedroferreira Feb 28, 2024
f0ee170
Circle CI
apedroferreira Feb 28, 2024
e033bd8
Template
apedroferreira Feb 28, 2024
27943fe
Fix weird file swaps
apedroferreira Feb 28, 2024
9eacf45
Rename in UI
apedroferreira Feb 28, 2024
620c3be
Add back docs
apedroferreira Feb 28, 2024
eec4c61
Update pnpm.lock
apedroferreira Feb 28, 2024
5103c07
Adjust docs
apedroferreira Feb 28, 2024
1f1cc58
Adjust docs more
apedroferreira Feb 28, 2024
b9c9b9a
Prettier
apedroferreira Feb 28, 2024
e614679
json schemas
apedroferreira Feb 28, 2024
16659fa
API docs
apedroferreira Feb 28, 2024
8fef139
Temporarily skip test that requires toolpad-studio to be published
apedroferreira Feb 28, 2024
d593f73
Merge remote-tracking branch 'upstream/master' into studio-rename
apedroferreira Feb 28, 2024
1959cec
It's all so tiresome
apedroferreira Feb 28, 2024
6f0e0dc
MUI Toolpad Studio to just Toolpad Studio
apedroferreira Feb 28, 2024
fa852ee
Review rerenamings
apedroferreira Mar 1, 2024
793d4e0
Revert extra renames
apedroferreira Mar 1, 2024
477a424
Merge remote-tracking branch 'upstream/master' into studio-rename
apedroferreira Mar 1, 2024
e12fdb4
Merge remote-tracking branch 'upstream/master' into pr/3238
Janpot Mar 6, 2024
153c657
fwrefreg
Janpot Mar 6, 2024
30a50f7
Update auth.ts
Janpot Mar 6, 2024
0735284
Update auth.ts
Janpot Mar 6, 2024
f4eb337
Update yarn.lock, struggling with tsup not being found
apedroferreira Mar 7, 2024
fb9b001
pnpm dedupe
apedroferreira Mar 7, 2024
68416e5
Rename packages
apedroferreira Mar 8, 2024
2bc0653
Fix CI
apedroferreira Mar 8, 2024
426dad0
Merge remote-tracking branch 'upstream/master' into studio-rename
apedroferreira Mar 8, 2024
0649298
Adjust to docs
apedroferreira Mar 8, 2024
324a526
Adjust docs links
apedroferreira Mar 8, 2024
08ea115
Rename wording in docs from Toolpad to Toolpad Studio where it makes …
apedroferreira Mar 8, 2024
5f1c1a1
Rebuild docs
apedroferreira Mar 8, 2024
a839819
Update commands in docs
apedroferreira Mar 8, 2024
7822354
smol update
apedroferreira Mar 8, 2024
3854f92
Fixing some Vale warning not sure if this is the issue
apedroferreira Mar 8, 2024
953a195
Revert "Fixing some Vale warning not sure if this is the issue"
apedroferreira Mar 8, 2024
691329f
Fix vale errors I guess
apedroferreira Mar 8, 2024
3909156
More vale fixes
apedroferreira Mar 8, 2024
c21b716
More vale fun
apedroferreira Mar 8, 2024
dd9730b
More vale
apedroferreira Mar 8, 2024
f69ddff
One more vale fix
apedroferreira Mar 8, 2024
2983bc7
More vale
apedroferreira Mar 8, 2024
782a5a1
more
apedroferreira Mar 8, 2024
a009dde
Wording
apedroferreira Mar 8, 2024
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: 3 additions & 3 deletions .codesandbox/ci.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
"node": "18",
"packages": [
"packages/create-toolpad-app",
"packages/toolpad-app",
"packages/toolpad-components",
"packages/toolpad-core",
"packages/toolpad-studio",
"packages/toolpad-studio-components",
"packages/toolpad-studio-runtime",
"packages/toolpad-utils"
],
"silent": true
Expand Down
4 changes: 2 additions & 2 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ pnpm-lock.yaml
/docs/export
/docs/schemas
/packages/**/dist
/packages/toolpad-app/.next
/packages/toolpad-app/public
/packages/toolpad-studio/.next
/packages/toolpad-studio/public

/examples/*/toolpad.yml

Expand Down
28 changes: 14 additions & 14 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ module.exports = {
zones: [
{
// Don't leak the internal runtime abstraction. It's on its way to be moved towards a separate package
target: './packages/toolpad-app/src/runtime',
from: './packages/toolpad-app/src/',
target: './packages/toolpad-studio/src/runtime',
from: './packages/toolpad-studio/src/',
except: ['./runtime'],
},
],
Expand All @@ -110,11 +110,11 @@ module.exports = {
{
files: [
'packages/create-toolpad-app/**/*',
'packages/toolpad/**/*',
'packages/toolpad-app/**/*',
'packages/toolpad-studio/**/*',
'packages/toolpad-studio/**/*',
'packages/toolpad-utils/**/*',
'packages/toolpad-core/**/*',
'packages/toolpad-components/**/*',
'packages/toolpad-studio-runtime/**/*',
'packages/toolpad-studio-components/**/*',
],
excludedFiles: ['tsup.config.ts', '*.spec.ts', '*.spec.tsx', 'vitest.config.ts'],
rules: {
Expand All @@ -127,9 +127,9 @@ module.exports = {
* 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-app/src/components/**/*',
'packages/toolpad-app/src/toolpad/**/*',
'packages/toolpad-app/src/runtime/**/*',
'packages/toolpad-studio/src/components/**/*',
'packages/toolpad-studio/src/toolpad/**/*',
'packages/toolpad-studio/src/runtime/**/*',
],
excludedFiles: ['*.spec.ts', '*.spec.tsx'],
rules: {
Expand All @@ -140,18 +140,18 @@ module.exports = {
// Starting small, we will progressively expand this to more packages.
files: [
// 'packages/create-toolpad-app/**/*',
// 'packages/toolpad/**/*',
// 'packages/toolpad-app/**/*',
// 'packages/toolpad-studio/**/*',
// 'packages/toolpad-studio/**/*',
'packages/toolpad-utils/**/*',
// 'packages/toolpad-core/**/*',
// 'packages/toolpad-components/**/*',
// 'packages/toolpad-studio-runtime/**/*',
// 'packages/toolpad-studio-components/**/*',
],
rules: {
'@typescript-eslint/no-explicit-any': ['error'],
},
},
{
files: ['packages/toolpad-app/pages/**/*'],
files: ['packages/toolpad-studio/pages/**/*'],
rules: {
// The pattern is useful to type Next.js pages
'react/function-component-definition': 'off',
Expand Down
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ lerna-debug.log

dist/

packages/toolpad-app/public/web_modules
packages/toolpad-app/public/runtime
packages/toolpad-app/public/typings.json
packages/toolpad-studio/public/web_modules
packages/toolpad-studio/public/runtime
packages/toolpad-studio/public/typings.json
examples/*/yarn.lock

test-results
Expand Down
58 changes: 29 additions & 29 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Local development

If you would like to hack on MUI Toolpad or want to run the latest version, you can follow these steps:
If you would like to hack on MUI Toolpad Studio or want to run the latest version, you can follow these steps:

_If you're looking into contributing to the docs, follow the [instructions](#building-and-running-the-documentation) down below_

Expand All @@ -13,7 +13,7 @@ _If you're looking into contributing to the docs, follow the [instructions](#bui

### Running apps inside the monorepo (recommended)

This will use the local version of Toolpad as built in the monorepo. This is recommended when your app is in a folder inside of the monorepo. You may even decide to temporarily move your app into the monorepo.
This will use the local version of Toolpad Studio as built in the monorepo. This is recommended when your app is in a folder inside of the monorepo. You may even decide to temporarily move your app into the monorepo.

1. Install dependencies:

Expand All @@ -27,15 +27,15 @@ This will use the local version of Toolpad as built in the monorepo. This is rec
pnpm dev
```

1. Run Toolpad
1. Run Toolpad Studio

```bash
pnpm toolpad dev test/integration/backend-basic/fixture/toolpad --dev
pnpm toolpad-studio dev test/integration/backend-basic/fixture/toolpad --dev
```

**Note:** It's important to note the difference between `pnpm toolpad dev` and the `--dev` parameter. The first instruction runs Toolpad in dev mode. The `--dev` parameter is one for contributors only and runs the underlying next.js app that powers the editor in dev mode. The latter makes sure the development build of React is being used and the editor frontend application runs in watch mode.
**Note:** It's important to note the difference between `pnpm toolpad-studio dev` and the `--dev` parameter. The first instruction runs Toolpad Studio in dev mode. The `--dev` parameter is one for contributors only and runs the underlying next.js app that powers the editor in dev mode. The latter makes sure the development build of React is being used and the editor frontend application runs in watch mode.

If your application has dependencies other than `@mui/toolpad`, you have to temporarily add it to the workspace:
If your application has dependencies other than `@toolpad/studio`, you have to temporarily add it to the workspace:

1. update `pnpm-workspace.yaml` (in the workspace root, not in your app), add your app folder to `workspaces.packages`. e.g. for `examples/qr-generator` which has a dependency on `qrcode` this would be:

Expand All @@ -62,15 +62,15 @@ If your application has dependencies other than `@mui/toolpad`, you have to temp
1. Make sure to start the build in watch mode again and the run the app with

```bash
pnpm toolpad dev examples/qr-generator/toolpad --dev
pnpm toolpad-studio dev examples/qr-generator/toolpad --dev
```

### Linking Toolpad in a folder on your system (advanced)
### Linking Toolpad Studio in a folder on your system (advanced)

<details>
<summary>Expand instructions</summary>

In some cases you may want to link local toolpad into a project on your laptop.
In some cases you may want to link local Toolpad Studio app into a project on your laptop.

1. Install dependencies:

Expand All @@ -84,33 +84,33 @@ pnpm install
pnpm dev
```

1. In another folder, start a toolpad project using:
2. In another folder, start a Toolpad Studio project using:

```json
{
"name": "toolpad-local",
"version": "1.0.0",
"license": "MIT",
"scripts": {
"dev": "toolpad dev --dev",
"build": "toolpad build --dev",
"start": "toolpad start --dev"
"dev": "toolpad-studio dev --dev",
"build": "toolpad-studio build --dev",
"start": "toolpad-studio start --dev"
},
"dependencies": {
"@mui/toolpad": "portal:<your-local-toolpad-monorepo>/packages/toolpad-app"
"@toolpad/studio": "portal:<your-local-toolpad-monorepo>/packages/toolpad-studio"
},
"resolutions": {
"@mui/toolpad": "portal:<your-local-toolpad-monorepo>/packages/toolpad-app",
"@mui/toolpad-core": "portal:<your-local-toolpad-monorepo>/packages/toolpad-core",
"@mui/toolpad-components": "portal:<your-local-toolpad-monorepo>/packages/toolpad-components",
"@mui/toolpad-utils": "portal:<your-local-toolpad-monorepo>/packages/toolpad-utils"
"@toolpad/studio": "portal:<your-local-toolpad-monorepo>/packages/toolpad-studio",
"@toolpad/studio-runtime": "portal:<your-local-toolpad-monorepo>/packages/toolpad-studio-runtime",
"@toolpad/studio-components": "portal:<your-local-toolpad-monorepo>/packages/toolpad-studio-components",
"@toolpad/utils": "portal:<your-local-toolpad-monorepo>/packages/toolpad-utils"
}
}
```

1. Replace `<your-local-toolpad-monorepo>` with the path to the toolpad monorepo on your file system. Make sure to keep `portal:`.
1. Replace `<your-local-toolpad-studio-monorepo>` with the path to the Toolpad Studio monorepo on your file system. Make sure to keep `portal:`.

1. In order to use `portal:` dependencies, we will need to use yarn 2. So start by running
2. In order to use `portal:` dependencies, we will need to use yarn 2. So start by running

```bash
yarn set version berry
Expand All @@ -122,13 +122,13 @@ pnpm install
nodeLinker: node-modules
```

1. then run
3. then run

```bash
yarn install
```

1. Run start toolpad in dev mode:
3. Run start toolpad-studio in dev mode:

```bash
yarn dev
Expand All @@ -147,7 +147,7 @@ The playwright tests can be run in one of two modes:
pnpm test:integration --project chromium
```

2. Toolpad in dev watchmode and run the integration tests in dev mode with the `TOOLPAD_NEXT_DEV` environment variable (slower)
2. Start Toolpad Studio in dev watchmode and run the integration tests in dev mode with the `TOOLPAD_NEXT_DEV` environment variable (slower)

```bash
pnpm dev
Expand Down Expand Up @@ -190,26 +190,26 @@ Use the `--ui` flag to run the tests interactively.
- Run it on your project of choice

```bash
pnpm toolpad dev /path/to/my/toolpad/project
pnpm toolpad-studio dev /path/to/my/toolpad/studio/project
```

## Using CodeSandbox CI

Each pull request is built on [CodeSandbox CI](https://codesandbox.io/docs/learn/sandboxes/ci). As a result of that we have a published Toolpad package for ever pull request. To use the package from the pull request, take the following steps:
Each pull request is built on [CodeSandbox CI](https://codesandbox.io/docs/learn/sandboxes/ci). As a result of that we have a published Toolpad Studio package for ever pull request. To use the package from the pull request, take the following steps:

1. In the GitHub PR checks, locate the ci/codesandbox check and make sure it has successfully finished building. Click on "details" to open the CodeSandbox CI user interface.

2. In the codesandbox UI, on the right panel, locate and expand the "Packages (6)" section.

3. Right click the link named `@mui/toolpad` and copy the address
3. Right click the link named `@toolpad/studio` and copy the address

![Copy CodeSandbox CI package link](contributing/codesandbox-ci-package-link.png)

4. In your `package.json`, for the `@mui/toolpad` dependency, replace the version with aforementioned link. e.g.
4. In your `package.json`, for the `@toolpad/studio` dependency, replace the version with aforementioned link. e.g.

```json
"dependencies": {
"@mui/toolpad": "https://pkg.csb.dev/mui/mui-toolpad/commit/<commit>/@mui/toolpad"
"@toolpad/studio": "https://pkg.csb.dev/mui/mui-toolpad/commit/<commit>/@toolpad/studio"
}
```

Expand All @@ -219,7 +219,7 @@ Each pull request is built on [CodeSandbox CI](https://codesandbox.io/docs/learn
pnpm --force
```

You'll now be able to explore your project with the Toolpad version from the GitHub PR.
You'll now be able to explore your project with the Toolpad Studio version from the GitHub PR.

## Sending a pull request

Expand Down
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<!-- markdownlint-disable-next-line -->
<p align="center">
<a href="https://mui.com/" rel="noopener" target="_blank"><img width="150" src="https://mui.com/static/logo.svg" alt="MUI Toolpad logo"></a>
<a href="https://mui.com/" rel="noopener" target="_blank"><img width="150" src="https://mui.com/static/logo.svg" alt="MUI Toolpad Studio logo"></a>
</p>

<h1 align="center">MUI Toolpad</h1>
<h1 align="center">MUI Toolpad Studio</h1>

<div align="center">

Quickly build internal tools. MUI Toolpad is a self-hosted low-code internal tools builder designed to extend the [MUI](https://mui.com/) React components. It's designed for developers of all trades who want to save time building internal applications.
Quickly build internal tools. MUI Toolpad Studio is a self-hosted low-code internal tools builder designed to extend the [MUI](https://mui.com/) React components. It's designed for developers of all trades who want to save time building internal applications.

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mui/material-ui/blob/HEAD/LICENSE)

<!--
[![npm latest package](https://img.shields.io/npm/v/@mui/toolpad/latest.svg)](https://www.npmjs.com/package/@mui/toolpad)
[![npm next package](https://img.shields.io/npm/v/@mui/toolpad/next.svg)](https://www.npmjs.com/package/@mui/toolpad@beta)
[![npm downloads](https://img.shields.io/npm/dm/@mui/toolpad.svg)](https://www.npmjs.com/package/@mui/toolpad)
[![npm latest package](https://img.shields.io/npm/v/@toolpad/studio/latest.svg)](https://www.npmjs.com/package/@toolpad/studio)
[![npm next package](https://img.shields.io/npm/v/@toolpad/studio/next.svg)](https://www.npmjs.com/package/@toolpad/studio@beta)
[![npm downloads](https://img.shields.io/npm/dm/@toolpad/studio.svg)](https://www.npmjs.com/package/@toolpad/studio)
-->

[![CircleCI](https://circleci.com/gh/mui/mui-toolpad/tree/master.svg?style=shield)](https://app.circleci.com/pipelines/github/mui/mui-toolpad?branch=master)
Expand All @@ -27,35 +27,35 @@ Quickly build internal tools. MUI Toolpad is a self-hosted low-code internal to

## We are making some changes

A [big change](https://github.com/mui/mui-toolpad/discussions/1748) is coming: we're making Toolpad focus much more on integrating with your IDE while providing the ease of building UI fast with a drag and drop.
A [big change](https://github.com/mui/mui-toolpad/discussions/1748) is coming: we're making Toolpad Studio focus much more on integrating with your IDE while providing the ease of building UI fast with a drag and drop.

## Product walkthrough

![readme_video](https://github.com/prakhargupta1/mui-toolpad/assets/92228082/efcab7c7-4f34-487c-8a62-e059b5e58bcc)

## Notice

MUI 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.
MUI Toolpad Studio 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

Run:

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

## Documentation

Check out our [documentation](https://mui.com/toolpad/getting-started/).
Check out our [documentation](https://mui.com/toolpad/studio/getting-started/).

## Examples

Check out our [mui-public](https://github.com/mui/mui-public) repo to see how a Toolpad app looks in production.
Check out our [mui-public](https://github.com/mui/mui-public) repo to see how a Toolpad Studio app looks in production.

## Contributing

Expand All @@ -70,7 +70,7 @@ The [changelog](https://github.com/mui/mui-toolpad/releases) is regularly update

## Roadmap

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

## License

Expand Down
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
```bash
npx https://pkg.csb.dev/mui/mui-toolpad/commit/<build>/create-toolpad-app smoke --use-pnpm
cd smoke
pnpm add https://pkg.csb.dev/mui/mui-toolpad/commit/<build>/@mui/toolpad -S
pnpm add https://pkg.csb.dev/mui/mui-toolpad/commit/<build>/@toolpad/studio -S
pnpm dedupe && pnpm dev
```

Expand Down
2 changes: 1 addition & 1 deletion docs/data/toolpad/core/api/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API reference

<p class="description">This page contains an index to the most important javascript APIs of Toolpad.</p>
<p class="description">This page contains an index to the most important JavaScript APIs of Toolpad.</p>

## Components

Expand Down
2 changes: 1 addition & 1 deletion docs/data/toolpad/studio/components/button/ButtonBasic.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import * as React from 'react';
import { Button } from '@mui/toolpad-components';
import { Button } from '@toolpad/studio-components';

const TOOLPAD_PROPS = {
variant: 'contained',
Expand Down
2 changes: 1 addition & 1 deletion docs/data/toolpad/studio/components/button/ButtonColor.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import * as React from 'react';
import { Button } from '@mui/toolpad-components';
import { Button } from '@toolpad/studio-components';
import { Stack } from '@mui/material';

const TOOLPAD_PROPS1 = {
Expand Down
2 changes: 1 addition & 1 deletion docs/data/toolpad/studio/components/button/ButtonSize.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import * as React from 'react';
import { Button } from '@mui/toolpad-components';
import { Button } from '@toolpad/studio-components';
import Stack from '@mui/material/Stack';

const TOOLPAD_PROPS1 = {
Expand Down
2 changes: 1 addition & 1 deletion docs/data/toolpad/studio/components/button/ButtonState.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import * as React from 'react';
import { Button } from '@mui/toolpad-components';
import { Button } from '@toolpad/studio-components';
import { Stack } from '@mui/material';

const TOOLPAD_PROPS1 = {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import * as React from 'react';
import { Button } from '@mui/toolpad-components';
import { Button } from '@toolpad/studio-components';
import { Stack } from '@mui/material';

const TOOLPAD_PROPS1 = {
Expand Down
Loading
Loading