server

fastify + TypeORM + mercurius

GraphQL API

https://api.bgm.tv/v0/altair/

schema

REST API

https://next.bgm.tv/p1/

开发

安装依赖

使用 pnpm 进行依赖管理

启用 pnpm

手动安装 pnpm

(或者直接使用 corepack)

corepack enable
corepack prepare --activate

安装 npm 依赖

pnpm i

启动

复制 .env.example 到 .env，config.example.yaml 到 config.yaml，根据自己的开发环境设置相关配置。 环境变量(及.env文件)会覆盖 config.yaml 中的设置。

如果你是在本机启动了 dev-env 中的 docker-compose，可以直接使用默认设置。

pnpm start

在文件修改后会自动重启。

测试

jest 对于 esm 的支持不好，所以使用 vitest 作为测试框架。

运行测试需要 mysql。

pnpm test