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 ./...

這將執行所有測試，並打印代碼覆蓋範圍百分比。

貢獻指南

每個貢獻都有改變

在您貢獻之前，請先閱讀貢獻指南。

特別感謝