https://github.com/traptitech/trap-collection-server
内製ゲーム管理システム traP Collection サーバーアプリケーション
https://github.com/traptitech/trap-collection-server
hacktoberfest
Last synced: 12 months ago
JSON representation
内製ゲーム管理システム traP Collection サーバーアプリケーション
- Host: GitHub
- URL: https://github.com/traptitech/trap-collection-server
- Owner: traPtitech
- Created: 2019-07-19T14:25:44.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-07-10T14:59:20.000Z (12 months ago)
- Last Synced: 2025-07-10T20:19:05.117Z (12 months ago)
- Language: Go
- Homepage:
- Size: 20.7 MB
- Stars: 8
- Watchers: 10
- Forks: 0
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# trap-collection-server
[](https://codecov.io/gh/traPtitech/trap-collection-server)
[](https://github.com/traPtitech/trap-collection-server/actions)
[-docs-brightgreen)](https://apis.trap.jp/?urls.primaryName=traP%20Collection%20v1%20API)
[-docs-brightgreen)](https://apis.trap.jp/?urls.primaryName=traP%20Collection%20v2%20API)
[](https://goreportcard.com/report/traPtitech/trap-collection-server)
[](https://deepwiki.com/traPtitech/trap-collection-server)
traPのゲームランチャーtraP Collectionのサーバーサイドです。
## 開発に必要なツール
- Go (最新のもの)
- Docker
- [Task](https://taskfile.dev/)
- タスクランナー
- [Atlas](https://atlasgo.io/)
- DBマイグレーション用のツール
- マイグレーションの詳細は [migration.md](docs/migration.md) を参照してください。
- [golangci-lint](https://golangci-lint.run/)
- 静的解析用のツール
必要なものをインストールしたら、次に以下のコマンドを実行すると、Goの依存関係がインストールされ、コードが生成されます。
```bash
task
```
`src/service/mock` ディレクトリなどにファイルが生成されていればよいです。
## 開発環境の起動
まず、[traQ BOT Console](https://bot-console.trap.jp/docs/client/create)に従い、
traQのOAuthクライアントを作成します。リダイレクト先URLは`http://localhost:8080/callback`、スコープは「読み取り」、に設定してください。
次に、`docker/dev/.env`ファイルに以下のように書きます。
```.env
CLIENT_ID={{traQのClientのClientID}}
CLIENT_SECRET={{traQのClientのClientSecret}}
```
最後に以下のコマンドを実行することで開発環境がポート3000番で起動します。
また、管理画面のWeb UIをhttp://localhost:8080 で、[Adminer](https://www.adminer.org/)をhttp://localhost:8081 で開けるようになります。
```bash
task dev
```
### DBのデータ削除
以下のコマンドを実行することでDBのデータを削除できます。
```bash
task clean:db
```
## テストの実行
GitHub Actionsで走っているのと同様のテストを以下のコマンドで実行できます。
ログの停止からtestのログが流れ始めるまで20秒程度時間が空く点に注意してください。
DB に関わるテストは、Dockerが必要です。
```bash
task test
```
`task test`では全てのテストが実行されます。開発中に関数ごとのテストを実行したい場合は、コマンドでテスト対象の関数を指定して実行することもできますが、エディタの機能を使うとよいです。
例えば VSCode では、エディタのテスト関数の上にある「run test」ボタンやコマンドパレットなどから実行できます。
## lint の実行
golangci-lint を使ってコードを静的解析し、良くないコードが無いかをチェックすることができます。
古いコードではgolangci-lintのルールに従っていないものもありますが、それらを直す必要はありません。
新しいコードを書くときは、golangci-lintのルールに従うようにしてください。
`main`ブランチとの差分（自分が書いたコード）の中に良くないコードが無いかを以下のコマンドでチェックできます。
```bash
task lint
```
GitHub Actionsでもgolangci-lintが実行されています。こちらもmainブランチとの差分に良くないコードが無いかをチェックしていますが、CIのログ出力には全てのエラーが出力されるため、注意してください。PRに含まれる部分だけ修正すればよいです。
## DBスキーマの再生成
以下のコマンドでDBスキーマのドキュメント(`docs/db_schema`)を再生成できます。
```bash
task tbls
```
## マイグレーションについて
[docs/migration.md](docs/migration.md)を参照してください。
## API スキーマについて
OpenAPI を使っています。APIスキーマは、 [docs/openapi/v2.yaml](docs/openapi/v2.yaml) に書かれており、このファイルを元に [src/handler/v2/openapi](src/handler/v2/openapi) 以下にコードが生成されます。
また、OpenAPI スキーマのドキュメントは [traP API ドキュメント](https://apis.trap.jp/?urls.primaryName=traP%20Collection%20v2%20API) で参照できます。
## その他ドキュメント
アプリの中で出てくる概念(game, editionなど)の定義やディレクトリ構成の説明は、部内のwikiの他、[.github/copilot-instructions.md](.github/copilot-instructions.md) にも書かれています。
DeepWiki というサービスでAIによって生成されたドキュメントを閲覧し、AIに質問することもできます([https://deepwiki.com/traPtitech/trap-collection-server](https://deepwiki.com/traPtitech/trap-collection-server))。ただし、このドキュメントは最新のものを参照しているとは限らないので注意してください。