全国の大学の研究室プラットフォーム。バックエンドrepo。
# イメージビルドおよびコンテナ起動
$ make bu
# コンテナ内に入る
$ make in
# マイグレーション
$ make migrate
# 初期データ挿入
$ make seedサーバー起動したら、ホスト側で以下のURLでアクセス可能
- API http://localhost:8081
- adminer http://localhost:8082
以下のURLで表示可能 http://localhost:8081/swagger/index.html
openapi生成ツールは、https://github.com/swaggo/swag/を利用。
- 上記公式サイトのドキュメントに則って、コメントを追加し、
$ make swagを実行。 /docsディレクトリにファイルが作成される- http://localhost:8081/swagger/index.htmlにアクセス
コンテナ内で以下のコマンドを実行
# フォーマッター
$ make format
# リンター
$ make lintテストを実行するのみであれば以下のコマンドで行う
$ maek testより詳細なテストのカバレッジを表示したい場合は以下のコマンドを実行
# coverage.htmlの作成(コンテナ内)
$ make mc
# ブラウザで表示(ホスト側)
$ make wc開発用データベース情報
| 項目 | 値 |
|---|---|
| データベース種類 | MySQL |
| サーバ | db |
| ユーザ名 | admin |
| パスワード | password |
| データベース | ulabhome |
$ make dry-migrateでDDLを確認して、$ make migrateでマイグレーションする流れとなる
# マイグレーションする際に発光されるDDLを確認(実行はされない)
$ make dry-migrate
# マイグレーション適用
$ maae migrate./_tool/mysql/seed.sqlに初期データを挿入するコマンドを記述
$ make seed