lila-docker

使用 Docker Compose 的 Lichess 开发环境，适用于在 Mac、Linux 或 Windows（通过 WSL）上进行开发。

在您的本地机器上运行的唯一要求是 git 和 Docker Desktop。所有其他依赖项（Scala、MongoDB、Node.js 等）都安装并在 Docker 容器中运行。

在 Gitpod 中运行

作为在本地机器上运行的替代方案，您可以使用 Gitpod（一个免费的、在线的、类似于 VS Code 的 IDE）进行贡献。只需单击一下，它将启动一个工作区并自动执行以下操作：

• 克隆必要的 Lichess 仓库
• 安装所有依赖项
• 用测试数据填充您的数据库
• 启动您的开发站点

点击此处创建工作区：

指令

1. 安装 Docker Desktop 并确保它正在运行

2. 克隆此仓库：

   git clone https://github.com/lichess-org/lila-docker

3. 启动服务

   cd lila-docker
   ./lila-docker start

   启动新服务可能需要 5-10 分钟。一些服务会在其他服务之前启动，您可能会在所有服务上线之前在日志中看到错误。

   Lila 将是最后一个完成的服务，此时您可以访问 http://localhost:8080/ 来查看站点。

停止

要停止容器，以便稍后通过 ./lila-docker start 恢复：

./lila-docker stop

要移除容器：

./lila-docker down

URL

始终可用：

根据您启动的可选服务：

使用

Scala 开发：

在对任何 Scala 代码进行更改后，重新启动 lila：

./lila-docker lila restart

UI (JS/CSS) 开发：

要监视 Typescript/SCSS 更改并自动重新编译：

./lila-docker ui

更新路由

如果您编辑了 conf/routes 文件，则需要更新路由缓存。

docker compose exec lila ./lila playRoutes

添加翻译键：

修改 translation/source/*.xml 文件后，运行：

docker compose run --rm ui /lila/bin/trans-dump

代码格式化：

./lila-docker format

可选：使数据库持久化

docker compose cp mongodb:/data/db ./database

然后在 docker-compose.yml 中将 - ./database:/data/db 添加到 mongodb 卷

Berserk（Python 库）：

安装 Berserk 的开发版本，并针对您的本地开发站点运行一个示例脚本：

docker compose run --rm -w /berserk python \
    bash -c "pip install -e . && python /scripts/berserk-example.py"

Scala Metals（IDE 助手）：

1. 在 VS Code 中打开此 lila-docker 项目并安装 Dev Containers 扩展
2. Cmd+Shift+P > "Dev Containers: Rebuild and Reopen in Container"
3. 一个新的 VS Code 窗口将打开，连接到容器而不是您的主机机器
4. 文件 > 打开文件夹 > "/workspaces/lila-docker/repos/lila"（或您想要工作的任何 Scala 项目）
5. 安装 + 启用 Scala Metals 扩展（Cmd+Shift+X > "Scala (Metals)")
6. Cmd+Shift+P > "Metals: Import build"

一旦构建被导入，当您打开 Scala 文件时，您应该拥有代码完成、跳转到定义等功能。

Scalachess：

如果您正在修改 Scalachess 库，您可以让 lila 使用它而不是发布到 Maven 的版本：

1. 更新 scalachess 仓库中的 build.sbt 文件：

   -  ThisBuild / version           := "15.6.7"
   +  ThisBuild / version           := "my-test-1"  # 给它一个自定义版本

2. 更新 lila 仓库中的 Dependencies.scala 文件：

   -  val chess = "org.lichess" %% "scalachess" % "15.6.7"
   +  val chess = "org.lichess" %% "scalachess" % "my-test-1"

3. 发布本地 scalachess 更改并重新启动 lila：

   docker compose exec -w /scalachess lila sbt publishLocal
   docker compose restart lila

其他 Scalachess 命令：

## 格式化
docker compose run --rm -w /scalachess --entrypoint="sbt check" lila
docker compose run --rm -w /scalachess --entrypoint="sbt prepare" lila

## 编译
docker compose run --rm -w /scalachess --entrypoint="sbt compile" lila

## 测试
docker compose run --rm -w /scalachess --entrypoint="sbt testKit/test" lila

## 打包
docker compose run --rm -w /scalachess --entrypoint="sbt package" lila

Dartchess：

## 运行格式化程序
docker compose run --rm -w /dartchess mobile dart format .

## 分析
docker compose run --rm -w /dartchess mobile bash -c "dart pub get && dart analyze"

## 运行测试
docker compose run --rm -w /dartchess mobile bash -c "dart pub get && dart test -x full_perft"

本地开发 Chessground

默认情况下，您的本地 lila 实例将使用发布到 npm 的 chessground 版本。如果您想要修改该库并看到它们在您的本地 lila 实例中的反映，您可以执行以下操作：

1. 更新 lila 仓库中的 package.json：

   "dependencies": {
   -  "chessground": "^8.3.11",
   +  "chessground": "link:/chessground",
   }

2. 以监视模式启动 chessground 编译器：

   docker compose run --rm -w /chessground ui bash -c "pnpm install && pnpm run compile --watch"

3. 以监视模式启动 lila ui 构建：

   ./lila-docker ui

然后您可以在 http://localhost:8090/demo.html 查看更新后的 chessground 演示，并在刷新 lila 时，它将使用 chessground 的本地副本。

本地开发 PGN 查看器

在进行更改后重新编译 PGN 查看器：

docker compose run --rm -w /pgn-viewer ui bash -c "pnpm run sass-dev && pnpm run bundle-dev"

在 PGN 查看器演示页面上查看更改：http://localhost:8091/

InfluxDB 监控

要查看 InfluxDB 监控仪表板，请启动您的环境并启用 Monitoring 服务，然后访问 http://localhost:8086/ (admin/password)

您还可以通过运行以下命令查看记录的所有指标：

curl --get http://localhost:8086/query \
    --header "Authorization: Token secret" \
    --data-urlencode "db=kamon"  \
    --data-urlencode "q=show measurements;"