Custom server

Run Toolpad Studio applications programmatically in existing node.js servers.

The Toolpad Studio dev command comes with its own built-in server. However, sometimes you'd want more control over the way Toolpad Studio applications are hosted within your application. The Toolpad Studio custom server integration API allows you to run a Toolpad Studio application programmatically within an existing node.js server.

The following code illustrates how it works:

// ./server.mjs
import { createHandler } from '@toolpad/studio';
import express from 'express';

const app = express();

// Initialize the Toolpad Studio handler. Make sure to pass the base path
const { handler } = await createHandler({
  dev: process.env.NODE_ENV === 'development',
  base: '/my-app',
});

// Use the handler in your application
app.use('/my-app', handler);

app.listen(3001);

To run the custom server you'll have to update the scripts in your your package.json

{
  "scripts": {
    "dev": "NODE_ENV=development node ./server.mjs",
    "start": "NODE_ENV=production node ./server.mjs",
    "build": "toolpad-studio build --base /my-app",
    "edit": "toolpad-studio editor http://localhost:3001/my-app"
  }
}

Now you can use the corresponding commands to interact with Toolpad Studio in the custom server