README_EN.md

Kagawa(Unofficial) COVID-19 Task Force website

日本語 | English

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 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

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://covid19-kagawa.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-kagawa.netlify.com/) will be also updated.

Branch rules

Pull Request is allowed only for development.
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://covid19-kagawa-dev.netlify.com/	base branch. Basically send a Pull Request here
Production	master	https://covid19-kagawa.netlify.com/	Pull Requests other than Administrators are prohibited