(TODO: 日本語以外の対応)
Issues にあるいろいろな修正にご協力いただけると嬉しいです。
詳しくは貢献の仕方を御覧ください。
詳しくはサイト構築にあたっての行動原則を御覧ください。
本ソフトウェアは、MITライセンスの元提供されています。
Link先を御覧ください。
翻訳をお手伝いいただける方は、こちらのドキュメントを御覧ください。
- 必要となる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 --buildyarn を使う場合
$ yarn installdocker compose を使う場合
$ docker-compose run --rm app yarn install- VSCodeの拡張機能「Remote Development」を導入します。
- この画像（外部サイト）のように左下部の「Open Folder in Container」でこのリポジトリのルートを選択すれば環境構築が始まります。
[Topic]
- 設定を変更したい場合は、
.devcontainer/devcontainer.jsonを修正してください。
詳細はdevcontainer.jsonのリファレンスを参照してください。 - Remote Container実行時のみ有効な拡張機能「ESlint」を導入していますが、必要に応じて
devcontainer.jsonのextensionsに追加してください。
詳細な手順はこちら（外部サイト）を参照してください。 - 開発環境を再構築する場合は、左下部の「Rebuild Container」を実行してください。
process.env.GENERATE_ENV の値が、本番の場合は'production'に、それ以外の場合は 'development' になっています。
テスト環境のみで実行したい処理がある場合はこちらの値をご利用ください。
master ブランチがアップデートされると、自動的に production ブランチにHTML類がbuildされます。
そして、本番サイト （未定） が更新されます。
staging ブランチがアップデートされると、自動的に gh-pages ブランチにHTML類がbuildされます。
そして、ステージングサイト （未定） が更新されます。
development ブランチがアップデートされると、自動的に dev-pages ブランチにHTML類がbuildされます。
development ブランチがアップデートされると、自動的に dev-pages ブランチにHTML類がbuildされます。そして、開発用サイト https://dev-niigata-informal.netlify.com/ が更新されます。
development, dev-i18n, dev-hotfix 以外は Pull Request は禁止です。
Pull Request を送る際の branch は、以下のネーミングルールでお願いします。
機能追加系： feature/#{ISSUE_ID}-#{branch_title_name} ホットフィックス系: hotfix/#{ISSUE_ID}-#{branch_title_name}
| 目的 | ブランチ | 確認URL | 備考 |
|---|---|---|---|
| 開発 | development | https://dev-niigata-informal.netlify.com/ | base branch。基本はこちらに Pull Requestを送ってください |
| 緊急適用用 | dev-hotfix | なし | 急ぎ本番に適用するべき修正。管理者から依頼された場合こちらを使ってください |
| i18n 作業用 | dev-i18n | なし | テンポラリで使っています |
| ステージング | staging | なし | 本番前の最終確認用。管理者以外の Pull Request は禁止です |
| 本番 | master | https://niigata.stopcovid19.jp/ | 管理者以外の Pull Request は禁止です |
| 目的 | ブランチ | 確認URL | 備考 |
|---|---|---|---|
| 本番サイトHTML | production | なし/ | 静的ビルドされたHTMLが置いてある場所 |
| ステージングサイト HTML | gh-pages | なし | 静的ビルドされたHTMLが置いてある場所 |
| OGP作業用 | deploy/new_obp | なし | OGPの更新用 |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent