Skip to main content

开发

如果您希望为 Komodo 做贡献，本页面是设置 Komodo 开发环境的起点。

依赖​

从源代码运行 Komodo 需要 Docker（并且可以使用附带的 devcontainer），或者可以在本地安装开发依赖项：

  • 后端（核心/外围 API）
    • 通过 rustup 安装程序 安装稳定的 Rust
    • 本地可用的 MongoDB 或 FerretDB。
    • 在 Debian/Ubuntu 上：需要 apt install build-essential pkg-config libssl-dev 来构建 rust 源代码。
  • 前端 (Web UI)
    • Node >= 18.18 + NPM
      • Yarn - (提示：安装 node 后使用 corepack enable 来使用 yarn)
    • typeshare
    • Deno >= 2.0.2

runnables-cli​

mbecker20/runnables-cli 可以用作一个方便的 CLI，用于运行 runfile.toml 中的常见项目任务。否则，您可以通过引用 runfile.toml 中的 cmd 来创建自己的项目任务。下面的所有说明都将使用 runnables-cli v1.3.7+。

Docker​

对项目进行更改后，运行 run dev-compose-build 以重新构建 Komodo，然后运行 run dev-compose-exposed 以启动一个 Komodo 容器，其 UI 可在 localhost:9120 访问。对源文件所做的任何更改都将需要重新运行 dev-compose-build 和 dev-compose-exposed 命令。

Devcontainer​

使用附带的 .devcontainer.json 和 VSCode 或其他兼容的 IDE，一键启动一个完整的环境，包括数据库。

提供了用于构建和运行 Komodo 的 VSCode 任务。

使用 devcontainer 打开存储库后，运行 Init 任务以构建前端/后端。然后，可以使用 Run Komodo 任务来运行前端/后端。还提供了用于重建/仅运行堆栈的一个组件（核心 API、外围 API、前端）的其他任务。

本地​

要从非容器环境运行完整的 Komodo 实例，请按此顺序运行命令：

  • 确保依赖项是最新的
    • rustup update -- 确保 rust 工具链是最新的
  • 构建并运行后端
    • run dev-core -- 构建并运行核心 API
    • run dev-periphery -- 构建并运行外围 API
  • 构建前端
    • 安装 typeshare-cli：cargo install typeshare-cli
    • 运行一次 -- run link-client -- 生成 TS 客户端并链接到前端
    • 运行上述一次后：
      • run gen-client -- 重建客户端
      • run dev-frontend -- 以开发（监视）模式启动
      • run build-frontend -- 类型检查和构建

文档站点开发​

使用 run dev-docsite 以开发模式启动 Docusaurus Komodo 文档站点。对 ./docsite 中文件所做的更改将由服务器自动重新加载。