Skip to content

Latest commit

 

History

History
111 lines (77 loc) · 4.96 KB

README_EN.md

File metadata and controls

111 lines (77 loc) · 4.96 KB
Raw

Niigata COVID-19 Task Force website

Niigata COVID-19 Task Force website

日本語 | English | Spanish | Korean | Chinese (Taiwan) | Chinese (Simplified) | Vietnamese | Thai | French

How to Contribute

All contributions are welcome! Please check How to contribute for details.

Code of Conduct

Please check Code of conduct for developers for details.

License

This software is released under the MIT License.

For Translators

Please check How to translate doc.

For Developers

How to Set Up Environments

  • Required Node.js version: 10.19.0 or higher

Use yarn

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn dev

Use docker

# serve with hot reload at localhost:3000
$ docker-compose up --build

How to resolve Cannot find module **** error

Use yarn

$ yarn install

Use docker

$ docker-compose run --rm app yarn install

[please translate me]

VSCode + Remote Cotainersで開発する場合

  1. VSCodeの拡張機能「Remote Development」を導入します。
  2. この画像（外部サイト）のように左下部の「Open Folder in Container」でこのリポジトリのルートを選択すれば環境構築が始まります。

[Topic]

  • 設定を変更したい場合は、.devcontainer/devcontainer.jsonを修正してください。
    詳細はdevcontainer.jsonのリファレンスを参照してください。
  • Remote Container実行時のみ有効な拡張機能「ESlint」を導入していますが、必要に応じてdevcontainer.jsonのextensionsに追加してください。
    詳細な手順はこちら（外部サイト）を参照してください。
  • 開発環境を再構築する場合は、左下部の「Rebuild Container」を実行してください。 [/please translate me]

Detect production/others environment

On the production environment, 'production' is assigned to process.env.GENERATE_ENV variable, on the other case 'development' is assigned to the variable. Please use the variable to detect which enviroinment is used at the runtime.

Deployment to Staging & Production Environments

When master branch is updated, the HTML files will be automatically built onto production branch, and then the production site (https://stopcovid19.metro.tokyo.lg.jp/) will be also updated.

When staging branch is updated, the HTML files will be automatically built onto gh-pages branch, and then the staging site (https://stg-covid19-tokyo.netlify.com/) will be also updated.

When development branch is updated, the HTML files will be automatically built onto dev-pages branch, and then the development site (https://dev-covid19-tokyo.netlify.com/) will be also updated.

Branch rules

Pull Request is allowed only for development, dev-i18n and dev-hotfix. Please use the following naming rules for the branch when sending a Pull Request.

Feature implementation: feature/#{ISSUE_ID}-#{branch_title_name} Hotfix commit: hotfix/#{ISSUE_ID}-{branch_title_name}

Basic branch

Purpose Branch Confirmation URL Remarks
Development development http://dev-covid19-tokyo.netlify.com/ base branch. Basically send a Pull Request here
Hotfix branch dev-hotfix None Fixes that should be applied to production in haste. Use this if requested by the administrator
i18n working branch dev-i18n https://i18n-covid-tokyo.netlify.com/ Temporarily used
Staging staging https://stg-covid19-tokyo.netlify.com/ For final confirmation before production. Non-admin pull requests are prohibited
Production master http://stopcovid19.metro.tokyo.lg.jp/ Pull Requests other than Administrators are prohibited

Branch used by the system

| Purpose | Branch | Confirmation URL | | ---- | -------- | ---- | ---- | Production site HTML | production | http://stopcovid19.metro.tokyo.lg.jp/ | Location where statically built HTML is located | Staging site HTML | gh-pages | https://stg-covid19-tokyo.netlify.com/ | Where to find statically built HTML | | For OGP working directory | deploy / new_obp | None | For updating OGP |