本ソフトウェアは、MITライセンスの元提供されています。
浜松版Covid19対策サイトの運営方法や開発に関する議論はSlackにて行っています。
Slack アカウントを持っていない場合、こちらから登録してください.
#code_for_hamamatsu チャンネルにご参加ください。
- 必要となるNode.jsのバージョン: 10.19.0以上
yarn を使う場合
# install dependencies
$ yarn install
# serve with hot reload at localhost:3000
$ yarn devdocker compose を使う場合
# serve with hot reload at localhost:3000
$ docker-compose up --build
$ docker exec -it covid19 sh
# コンテナに入ってから
/app yarn install
/app yarn devVagrant を使う場合
# serve with hot reload at localhost:3000
$ vagrant upyarn を使う場合
$ yarn installdocker compose を使う場合
$ docker-compose run --rm app yarn install起動後、http://localhost:3000 へアクセスする。
- VSCodeの拡張機能「Remote Development」を導入します。
- この画像(外部サイト)のように左下部の「Open Folder in Container」でこのリポジトリのルートを選択すれば環境構築が始まります。
yarn test:e2e
- 設定を変更したい場合は、
.devcontainer/devcontainer.jsonを修正してください。 詳細はdevcontainer.jsonのリファレンスを参照してください。 - Remote Container実行時のみ有効な拡張機能「ESLint」を導入していますが、必要に応じて
devcontainer.jsonのextensionsに追加してください。 詳細な手順はこちら(外部サイト)を参照してください。 - 開発環境を再構築する場合は、左下部の「Rebuild Container」を実行してください。
process.env.GENERATE_ENV の値が、本番の場合は'production'に、それ以外の場合は 'development' になっています。
テスト環境のみで実行したい処理がある場合はこちらの値をご利用ください。
main ブランチがアップデートされると、自動的にNetlifyにより、本番サイト https://stopcovid19.code4hamamatsu.org/ が更新されます。
main 以外は Pull Request は禁止です。 Pull Request を送る際の branch は、以下のネーミングルールでお願いします。
機能追加系: feature/#{ISSUE_ID}-#{branch_title_name}
ホットフィックス系: hotfix/#{ISSUE_ID}-#{branch_title_name}
2020/06/06
新機能開発のペースが落ち着いてきたため、devブランチを一旦廃止します。
今後のプルリクエストは main 宛に送ってください。
main へプルリクエストを送るとNetlifyによって検証用のURLが発行されるため、そのURLから変更内容の確認ができます。
| 目的 | ブランチ | 確認URL | 備考 |
|---|---|---|---|
| 開発(2020/06/06廃止) | dev-hamamatsu | https://dev-stopcovid19.code4hamamatsu.org/ | base branch。 |
| 本番 | main | https://stopcovid19.code4hamamatsu.org/ | base branch こちらからブランチ切って Pull Requestを送ってください |
| 目的 | ブランチ | 確認URL | 備考 |
|---|---|---|---|
| 本番サイトHTML | main | https://stopcovid19.code4hamamatsu.org/ | 静的ビルドされたHTMLが置いてある場所 |