For AI agents: the complete documentation index is available at /next/zh/llms.txt, the full documentation bundle is available at /next/zh/llms-full.txt, and this page is available as Markdown at /next/zh/lynxtron/introduction.md.
  • 简体中文
  • 快速上手 Lynxtron

    欢迎来到 Lynxtron 文档!我们将创建一个 Lynxtron 项目并开始开发。

    系统要求

    在开始之前,请确保您的开发环境满足以下要求:

    • Node.js 22 或更新的版本。您可以通过运行 node -v 来检查您的版本。
    • TypeScript: 项目可能使用 TypeScript 编写。
    • Chrome 浏览器: 用于调试 Lynxtron 主进程。
    • LynxDevTool: 用于调试 Lynx。您可以从这里下载。

    安装

    创建工程

    推荐通过以下命令来快速创建一个 Lynxtron 工程,执行:

    npm
    yarn
    pnpm
    bun
    deno
    npm create @lynx-js/lynxtron@latest

    跟随提示来创建一个 Lynxtron 项目。

    开始开发

    1. 进入 Lynxtron 项目
    cd <project-name>
    1. 安装依赖

      npm
      yarn
      pnpm
      bun
      deno
      npm install
    2. 启动应用

      npm
      yarn
      pnpm
      bun
      deno
      npm run start

    运行之后,您将看到 Hello Lynxtron 应用启动成功,如下图:

    调试应用

    1. 调试主进程

    主进程在 Node.js 中运行。您可以使用 Google Chrome 的开发者工具对其进行调试。

    1. 运行 npm run dev
    2. 打开 Google Chrome 并导航到 chrome://inspect
    3. 点击 Configure... 按钮,并确保 localhost:9222 在目标发现列表中。
    4. 您应该会在 Remote Target 下看到您的应用程序的 main.js,点击 inspect 打开开发者工具。

    现在您可以设置断点、检查变量以及查看来自 main.jsconsole.log 输出。

    2. 调试 Lynx

    Lynx 使用 LynxDevTool 进行调试。

    1. 确保 npm run dev 正在运行。
    2. 访问 Lynx DevTool 下载并打开 Lynx DevTool 桌面应用。
    3. 它应该会自动连接到开发服务器。您现在可以检查 UI 元素树、查看控制台输出以及调试您的 React 组件。

    打包您的应用程序

    你可以使用以下命令来打包你的应用程序:

    npm
    yarn
    pnpm
    bun
    deno
    npm run pack

    如果需要配置一些自定义参数,可以修改 electron-builder.yml 配置文件。

    关于 electron-builder.yml 的详细配置参数,请参考 electron-builder Configuration

    除非另有说明,本项目采用知识共享署名 4.0 国际许可协议进行许可,代码示例采用 Apache License 2.0 许可协议进行许可。