@tsukuba-shinkan/shinkan-web-api

筑波大学 新歓 Web の API サーバ

開発

.template.envをコピーし、.envを作成して、docker-composeで起動します。

docker-compose up --build

初回起動時に DB がセットアップされます。

開発モードではsrc以下を変更するとホットリロードされますが、それ以外の箇所（node_modules 含む）の変更は再実行（コンテナのリビルド）が必要です。

それ以外のスクリプトの使用

手動でDBを構築し起動する場合は、ローカルマシンのNode.jsを使用して起動できます。DBの接続先は、.envの設定に依存します。

# ホットリロードを使用して起動する
npm run dev

# 本番環境用で使用する
npm run build
npm start

テストの実行

npm test

本番環境での起動

アプリケーション用Dockerイメージは、環境変数SHINKAN_IS_DEVの存在を判定して起動モードを切り替えます。これは、docker-compose.override.ymlに記述されているため、以下のようにすると本番モードで起動させることができます。

docker-compose -f docker-compose.yml -f docker-compose.prod.yml up