/trap-collection-server

Primary LanguageGo

trap-collection-server

codecov OpenAPI(v1) OpenAPI(v2) go report

traPのゲームランチャーtraP Collectionのサーバーサイドです。

準備

この後の手順では

  • Go
  • Docker

が必要となります。

Taskをタスクランナーとして使用しているので、 Goをinstallした上で以下のコマンドを実行してinstallしてください。

go install github.com/go-task/task/v3/cmd/task

次に以下のコマンドを実行することで環境構築が完了します。

task

開発環境の起動

まず、traQ BOT Consoleに従い、 traQのOAuthクライアントを作成します。

次に、docker/dev/.envファイルに以下のように書きます。

CLIENT_ID={{traQのClientのClientID}}
CLIENT_SECRET={{traQのClientのClientSecret}}

最後に以下のコマンドを実行することで開発環境がポート3000番で起動します。 また、Web UIをhttp://localhost:8080 で、Adminerをhttp://localhost:8081 で開けるようになります。

task dev

DBのデータ削除

以下のコマンドを実行することでDBのデータを削除できます。

task clean:db

v1のAPIのみで起動

以下のコマンドを実行することで、現在の本番環境と同様のv1のAPIのみが有効な状態で起動できます。

task dev:v1

テストの実行

GitHub Actionsで走っているのと同様のテストを以下のコマンドで実行できます。 ログの停止からtestのログが流れ始めるまで20秒程度時間が空く点に注意してください。

task test

DBスキーマの再生成

以下のコマンドでDBスキーマのドキュメント(docs/db_schema)を再生成できます。

task tbls