跳到内容
+

自定义服务器

在现有的 node.js 服务器中以编程方式运行 Toolpad Studio 应用程序。

Toolpad Studio dev 命令自带内置服务器。但是,有时您可能希望更好地控制 Toolpad Studio 应用程序在您的应用程序中的托管方式。Toolpad Studio 自定义服务器集成 API 允许您在现有的 node.js 服务器中以编程方式运行 Toolpad Studio 应用程序。

以下代码说明了它的工作原理

// ./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);

要运行自定义服务器,您必须更新 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"
  }
}

现在您可以使用相应的命令在自定义服务器中与 Toolpad Studio 交互

命令          描述
yarn dev 在开发模式下运行自定义服务器。类似于运行 toolpad-studio dev 时打开应用程序预览
yarn start 在生产模式下运行 Toolpad Studio 应用程序。应用程序必须首先使用 toolpad-studio build 构建。确保提供正确的基本路径。
yarn build 为生产目的构建应用程序。请注意,您必须提供正确的基本路径
yarn edit 这将运行 Toolpad Studio 独立编辑器并将其连接到您的自定义服务器。现在您可以编辑应用程序,更改将反映在自定义服务器的 Toolpad Studio 项目文件夹中。