Skip to content

Latest commit

 

History

History
303 lines (203 loc) · 8.19 KB

CONTRIBUTING.md

File metadata and controls

303 lines (203 loc) · 8.19 KB
Raw

Contributing to Toolpad

Toolpad vs. MUI organization

Toolpad is an open-source project of the MUI organization. The repositories are part of the same codebase. mui/toolpad imports the code infrastructure from mui/material-ui. You can find the "contributing" guide for the main repository in mui/material-ui/CONTRIBUTING.md.

Most of the content in the main repository "contributing" guide applies to this repository. There are, however, a few differences:

  • The default GitHub branch might be different.
  • The local documentation site opens on a different port: 3003 instead of 3000.

Local development

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

If you're looking into contributing to the docs, follow the instructions down below

Prerequisites

  • git
  • node.js

Developing on Toolpad Core

This uses the local version of Toolpad Core as built in the mono-repository, and allows for quickly testing out changes and their results.

Some application examples for different JavaScript frameworks (such as Next.js, Vite…) are present in the playground folder that can be used to quickly develop on Toolpad Core on a live application.

  1. Install dependencies:

    pnpm install

  2. Run the built-in watch mode

    pnpm dev

  3. Run any application in the playground folder in development mode, such as nextjs

    cd playground/nextjs
    pnpm dev

Testing the example apps

You can also test the example apps to make sure they work as expected.

  1. Add the example app to the workspace

    packages:
  - 'packages/*'
  - 'docs'
  - 'test'
  - 'examples/nextjs'

  2. Run Toolpad Core locally

    pnpm --filter @toolpad/core dev

  3. Install then run the example app

    pnpm --filter core-nextjs install
    pnpm --filter core-nextjs dev

Running Toolpad Studio apps inside the monorepo (recommended)

This uses the local version of Toolpad Studio as built in the mono-repository. This is recommended when your app is in a folder inside of the mono-repository. You may even decide to temporarily move your app into the mono-repository.

  1. Install dependencies:

    pnpm install

  2. Run the built-in watch mode

    pnpm dev

  3. Run Toolpad Studio

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

    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 @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. For example; examples/qr-generator which has a dependency on qrcode this would be:

    packages:
  - 'packages/*'
  - 'docs'
  - 'test'
  - 'examples/qr-generator'

    You should also run pnpm dev as follows to avoid the dev scripts from kicking in

    pnpm dev --ignore qr-generator

  2. Run

    pnpm install

  3. Make sure to start the build in watch mode again and the run the app with

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

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

Expand instructions

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

  1. Install dependencies:
pnpm install

  1. Run the build in watch mode

    pnpm dev

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

    {
  "name": "toolpad-local",
  "version": "1.0.0",
  "license": "MIT",
  "scripts": {
    "dev": "toolpad-studio dev --dev",
    "build": "toolpad-studio build --dev",
    "start": "toolpad-studio start --dev"
  },
  "dependencies": {
    "@toolpad/studio": "portal:<your-local-toolpad-monorepo>/packages/toolpad-studio"
  },
  "resolutions": {
    "@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-studio-monorepo> with the path to the Toolpad Studio monorepo on your file system. Make sure to keep portal:.

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

      yarn set version berry

      and add to the .yarnrc.yml:

      nodeLinker: node-modules

    3. then run

      yarn install

  3. Run start toolpad-studio in dev mode:

    yarn dev

Running integration tests

The playwright tests can be run in one of two modes:

  1. Build the production target, then run the integration tests in production mode:

    pnpm release:build
pnpm test:integration --project chromium

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

    pnpm dev
TOOLPAD_NEXT_DEV=1 pnpm test:integration --project chromium

Use the --ui flag to run the tests interactively.

Building and running the documentation

  1. If you haven't already, install the project dependencies using

    pnpm install

  2. To start the documentation application in dev mode run

    pnpm docs:dev

    If all goes well it should print

    ready - started server on 0.0.0.0:3003, url: http://localhost:3003

  3. Open the docs application in the browser http://localhost:3003/toolpad

Reviewing PRs

  • Check out the PR branch locally with your tool of choice (GitHub Docs)

  • Run to build the project

    pnpm && pnpm release:build

  • Run it on your project of choice

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

Using CodeSandbox CI

Each pull request is built on CodeSandbox CI. As a result of that we have a published Toolpad Studio package for every 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 @toolpad/studio and copy the address

    Copy CodeSandbox CI package link

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

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

  5. Run

    pnpm --force

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

Sending a pull request

Please have a look at our general guidelines for sending pull requests.

Release process

See RELEASE.md