Skip to content

traPtitech/trap-collection-server

Folders and files

NameName
Last commit message
Last commit date
Jan 31, 2025
Feb 21, 2025
Dec 16, 2024
Oct 19, 2022
Feb 24, 2025
Dec 30, 2024
Dec 16, 2024
Sep 18, 2022
Oct 9, 2023
Sep 23, 2024
Dec 22, 2021
Dec 3, 2023
Jan 20, 2025
Dec 30, 2024
Feb 24, 2025
Feb 24, 2025
Mar 29, 2022
Feb 24, 2025

Repository files navigation

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@latest

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

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 で、Adminerhttp://localhost:8081 で開けるようになります。

task dev

DBのデータ削除

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

task clean:db

Permission deniedなどと表示される場合は、task downでアプリを止めた後にプロジェクトのルートでsudo rm -rf mysqlを実行してください。

テストの実行

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

task test

task testでは全てのテストが実行されます。開発中に関数ごとのテストを実行したい場合は、コマンドでテスト対象の関数を指定して実行することもできますが、エディタの機能を使うとよいです。 例えば VSCode では、エディタのテスト関数の上にある「run test」ボタンやコマンドパレットなどから実行できます。

DBスキーマの再生成

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

task tbls