batnoter api

BATNOTER API模块

这是使用Golang构建的Batnoter应用程序的API服务。

它公开了休息端点，以访问和管理用户GIT存储库中的Markdown注释。目前，它仅支持GitHub存储库存储和管理注释。

本地开发设置

先决条件

• GO版本1.18或更高版本
• Docker桌面

启动Postgres数据库容器

以下命令使用Docker启动数据库容器。

make network
make postgres
make createdb

从模板创建配置文件

config.yaml是包含默认配置值的配置模板文件。

cp config.yaml .config.yaml

应用程序使用.config.yaml文件以获取配置值。请将占位符价值从此配置文件更新为实际文件。

启动服务器

确保正确配置了.config.yaml文件，并且数据库容器已启动和运行。然后运行以下命令来设置DB架构并启动Web服务器。

go run main.go migrateup
go run main.go serve

这将在.config.yaml文件中指定的端口上启动服务器。您现在可以访问API端点。

运行测试

go test -v -cover ./...

这将执行所有测试，并打印代码覆盖范围百分比。

贡献指南

每个贡献都有改变

在您贡献之前，请先阅读贡献指南。

特别感谢