https://bgm.tv/ 新后端服务器。
Requirements
Optional Requirements:
Init
git clone --recursive https://github.com/bangumi/server.git bangumi-server
cd bangumi-server
task
设置
可设置的环境变量
MYSQL_HOST
默认 127.0.0.1
MYSQL_PORT
默认 3306
MYSQL_DB
默认 bangumi
MYSQL_USER
默认 user
MYSQL_PASS
默认 password
REDIS_URI
默认 redis://127.0.0.1:6379/0
HTTP_PORT
默认 3000
你也可以把配置放在 .env
文件中,go-task
会自动加载 .env
文件中的环境变量。
example:
MYSQL_HOST="127.0.0.1"
MYSQL_PORT="3306"
MYSQL_USER="user"
MYSQL_PASS="password"
MYSQL_DB="bangumi"
REDIS_URI="redis://:redis-pass@127.0.0.1:6379/1"
开发
bangumi 相关项目整体说明 bangumi/dev-docs
Web 框架: fiber
ORM: GORM 和 GORM Gen
后端环境
redis 和 mysql 都在此 docker-compose 内 https://github.com/bangumi/dev-env 。
如果你不使用 docker ,请自行启动 mysql 和 redis 并导入 bangumi/dev-env
仓库内的数据。
后端构架
flowchart LR
Users --> Cloudflare --> Old
subgraph Old[old server]
nginx
nginx --> |旧主站|php[old php server];
end
nginx ---> |转发api.bgm.tv/v0/的请求| Nginx(nginx on new server);
Cloudflare --> |next.bgm.tv 直接解析到新服务器|Nginx;
flowchart TD
Nginx(nginx on new server);
Nginx -->|static new frontend files|FS[(file system)];
Nginx -->|HTTP API Request|B;
Nginx --> |HTTP Search request|meilisearch;
C --> |增量更新数据|meilisearch;
B --> mysql
B --> |缓存|redis
C --> |清除失效缓存|redis
C --> |清除失效数据|mysql
kafka --> C;
subgraph B
direction BT
B1[chii web];
B2[chii web];
...
end
subgraph C[Kafka consumer]
C1[consumer 1];
end
meilisearch[(new search engine)];
subgraph Components[database]
direction BT
redis[(redis 缓存)]
mysql[(mysql)]
kafka[(kafka)]
mysql --> |binlog|kafka;
end
贡献指南
更多的细节介绍请查看贡献指南。
提交 Pull Request
如果你的 PR 是新功能,最好先发个 issue 讨论一下要不要实现,避免 PR 提交之后新功能本身被否决的问题。
如果已经存在相关的 issue,可以先在 issue 内回复一下自己的意向,或者创建一个 Draft PR 关联对应的 issue,避免撞车问题。
测试
使用 mock 进行部分测试。
task test
运行 hCaptcha 以外的的全部测试,需要数据库环境。
task test-all
使用 task test-all-with-http
或者 task coverage
来运行所有测试。
代码风格
task lint
配置文件
非 golang 文件 (yaml, json, markdown 等) 使用 prettier 进行格式化。
如果你没有 nodejs 环境,也可以直接提交 PR。GitHub Actions 会对文件进行检查并提出修改建议。
Go Mod
你不应当导入 github.com/bangumi/server/pkg
以外的任何路径。
具体可用的包见 pkg/readme.md
License
Copyright (C) 2021-2022 bangumi server contributors.
Source is licensed under the GNU AGPLv3 license that can be found in the LICENSE.txt file.