README_EN.md

Shiga COVID-19 Task Force website

日本語 | English |

BEWARE THAT THIS DOCUMENT MAY INCORRECT AT THIS MOMENT. JAPANESE VERSION IS PRIOR THAN ANY OTHER VERSION.

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.

##　Shiga version specific infomation

Our development direction

• Earlier first release is our first proority. Therefore,we won't work on internationalization before the website rereased in stable.
• Due to the same reason above,flow feature is also disabled.
• To re:enable those feature quickly, we just remobe those features from UIs,keeping other codes out of UI.

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 procition/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.pref.shiga.jp/) 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://frosty-lamarr-66d313.netlify.com/) will be also updated.