CONTRIBUTING.md

Contributing

Local development

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

Prerequisites

• git
• node.js
• Docker
• docker-compose

Steps

1. Start a local database:

   docker-compose -f ./docker-compose.dev.yml up -d

   You can skip this step if you already have a development database available by other means. Use the following command to stop the running container:

   docker-compose -f ./docker-compose.dev.yml down

2. Install dependencies:

   yarn install

3. Create a .env file in the root of the project

   TOOLPAD_DATABASE_URL=postgres://postgres:postgres@localhost:5432/postgres
   # For a custom port:
   # PORT=3004
   # EXTERNAL_URL=http://localhost:3004/

4. Now you can run the MUI Toolpad dev command to start the application

   yarn dev

5. Open http://localhost:3000/ in your browser.

Notes for contributors

• Changes that you make to the prisma model will be automatically compiled, but you'll have to push them to the db manually, either by restarting the yarn dev command, or by running

  yarn prisma db push

• In some cases, after the schema changes, the app may not start up and you may see the message:

  ⚠️  There might be data loss when applying the changes:

  This means your database is out of sync with the prisma schema and can't be synchronized without data loss. You can synchronise the database manually using:

  yarn prisma db push --accept-data-loss

Sending a pull request

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

Release process

See RELEASE.md