batnoter api
v1.0.0
これは、Golangで構築されたBatnoterアプリケーションのAPIサービスです。
RESTエンドポイントを公開して、ユーザーのGitリポジトリからマークダウンノートにアクセスおよび管理します。現在、メモを保存して管理するためのGitHubリポジトリのみをサポートしています。
1.18以上に行きます以下のコマンドは、Dockerを使用してデータベースコンテナを起動します。
make network
make postgres
make createdbconfig.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 ./...これにより、すべてのテストが実行され、コードカバレッジの割合も印刷されます。
すべての貢献は違いをもたらします
貢献する前に、貢献ガイドラインをお読みください。
