forked from stopcovid19-okayama/covid19
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
74eb41d
commit e3be320
Showing
11 changed files
with
190 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| version 1.0, 2020/3/3 | ||
| # Nossa missão | ||
|
|
||
| * Nós trabalharemos para proteger a vida e bem-estar dos cidadãos de Tokyo. | ||
| * Nós trabalharemos para prover fatos para todos, nacionalmente e internacionalmente. | ||
| * Nós demonstraremos nossa integridade e veremos os frutos de nosso trabalho. | ||
|
|
||
| # Código de conduta para desenvolvedores | ||
|
|
||
| ## Perspectiva do usuário | ||
|
|
||
| * Nós trataremos UX (Experiência do Usuário) como componente vital para manter as informações fáceis de se entender. | ||
| * Nós utilizaremos de evidências baseadas em fontes estatísticas como análises de acesso, análises de buscas por palavra-chave e análises de mídias sociais para tomar decisões. | ||
|
|
||
| ## Ninguém deixado para trás | ||
|
|
||
| * Nós famos desenvolver este site para todos, independente de nacionalidade, idade, gênero, etc. | ||
| * Nós seguiremos orientações de design universais para construir este website. | ||
|
|
||
| ## Internacional | ||
|
|
||
| * Nós vamos desenvolver este website para ser intuitivo e fácil de usar e entender. | ||
| * Nós iremos prover informações em múltiplos idiomas. | ||
|
|
||
| ## Seja franco | ||
|
|
||
| * Código aberto: Nós vamos lançar a maior parte dos nossos códigos fonte e conhecimento utilizados para construir este website de graça, para encorajar outras autoridades locais a utilizá-lo. | ||
| * Dados abertos: Nós vamos lançar os dados de graça, de forma reutilizável, disponível para todos. | ||
|
|
||
| ## Construído com as pessoas | ||
|
|
||
| * Nós trabalharemos juntos não apenas com o Governo Metropolitano de Tokyo, mas com qualquer pessoa que deseje contribuir. | ||
| * Nós recebemos contribuições de qualquer cidadão. | ||
| * Nós continuaremos melhorando este site para as pessoas que precisam de informação. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| # How to contribute | ||
|
|
||
| Contributors, thank you for participating in this project! | ||
|
|
||
| I'm Seki, the development manager. If you have any questions, feel free to ask me on Slack etc. | ||
|
|
||
| This page shows how you can contribute to the development of this site. | ||
|
|
||
| ## Comments on Issues and Pull Requests | ||
| * Feel free to comment on any Issues! Questions and suggestions are also welcome. | ||
| * Please search existing issues to make sure there is no similar issues before making a new issue. | ||
| * When you send a new Pull Request, please specify a related issue ID. We don't accept Pull Requests which has no issue ID. | ||
| * Note that Issues for improvement suggestions (labeled with `improve`) may not be always accepted (especially ones for UI) | ||
| * All issues and Pull requests including major content changes such as language expression or the UI are subject to the organizer's review. They may not necessarily be always accepted. | ||
| * The Issue with `waiting` label is under review by the organizer. The implementation should be refrained until the requirement is fixed. | ||
| * We appreciate if you give priority to the issues labelled [good first issue / help wanted / bug] | ||
|
|
||
| ## How to participate in communications | ||
| * If you do not have a "Code for Japan" Slack account, please register [here](https://cfjslackin.herokuapp.com/) | ||
| * Join `#covid19` Channel | ||
|
|
||
| ## For participation | ||
| * Please read [Principle / Code of Conduct](./CODE_OF_CONDUCT.md) before participating in development. | ||
| * For communication, please also check Code for Japan's [Code of Conduct](https://github.com/codeforjapan/codeofconduct). | ||
| * If you plan to work on an issue, please leave a comment behind to give a heads-up. | ||
| * [good first issue label](https://github.com/tokyo-metropolitan-gov/covid19/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) is recommended for beginners. | ||
| * If you can't make any progress for more than half a day, make sure that others can take over your work. | ||
| * If an issue is not updated for more than one day, we may remove the assignment. | ||
| * A [Draft Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests) is recommended for any work in progress, so that everyone understands the situation. | ||
| * Please discuss questions related to an Issue in the Issue comments instead of on Slack. | ||
| * We also accept suggestions! Please feel free to create new issues. | ||
|
|
||
| ## Development information | ||
| * Development site https://dev-covid19-tokyo.netlify.com/ | ||
| * Staging site https://stg-covid19-tokyo.netlify.com/ | ||
| * Production site https://stopcovid19.metro.tokyo.lg.jp/ | ||
| * [Design](https://www.figma.com/file/V7vt80p2gauhdgTZeVNbgj/UI%E3%83%87%E3%82%B6%E3%82%A4%E3%83%B3?node-id=121%3A156) | ||
| * [Translation Spreadsheet](https://docs.google.com/spreadsheets/d/1avT6QGInyQseYjoc_TxL8RPZfutyvrv4BtJkXfk1Nko) | ||
|
|
||
| Updates to this document are also welcome! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| # Tokyo COVID-19 Task Force website | ||
|
|
||
|  | ||
|
|
||
| [](https://stopcovid19.metro.tokyo.lg.jp/) | ||
|
|
||
|
|
||
| ### [日本語](./../../README.md) | English | [Español](./../es/README.md) | [한국어](./../ko/README.md) | [繁體中文](./../zh_TW/README.md) | [简体中文](./../zh_CN/README.md) | [Tiếng Việt](./../vi/README.md) | [ภาษาไทย](./../th/README.md) | [Français](./../fr/README.md) | ||
|
|
||
|
|
||
| ## How to Contribute | ||
|
|
||
| All contributions are welcome! | ||
| Please check [How to contribute](./CONTRIBUTING.md) for details. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| Please check [Code of conduct for developers](./CODE_OF_CONDUCT.md) for details. | ||
|
|
||
| ## License | ||
| This software is released under [the MIT License](./../../LICENSE.txt). | ||
|
|
||
| ## For Translators | ||
|
|
||
| Please check [How to translate](./../../TRANSLATION.md) doc. | ||
|
|
||
| ## For Developers | ||
|
|
||
| ### How to Set Up Environments | ||
|
|
||
| - Required Node.js version: 10.19.0 or higher | ||
|
|
||
| **Use yarn** | ||
| ```bash | ||
| # install dependencies | ||
| $ yarn install | ||
|
|
||
| # serve with hot reload at localhost:3000 | ||
| $ yarn dev | ||
| ``` | ||
|
|
||
| **Use docker** | ||
| ```bash | ||
| # serve with hot reload at localhost:3000 | ||
| $ docker-compose up --build | ||
| ``` | ||
|
|
||
| ### How to resolve `Cannot find module ****` error | ||
|
|
||
| **Use yarn** | ||
| ```bash | ||
| $ yarn install | ||
| ``` | ||
|
|
||
| **Use docker** | ||
| ```bash | ||
| $ docker-compose run --rm app yarn install | ||
| ``` | ||
|
|
||
| ### When developing with VSCode + Remote Containers | ||
|
|
||
| 1. The VSCode extension "[Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack)" is introduced. | ||
| 2. If you select the “Open Folder in Container” root of this repository (as seen in the lower left [here（external site）](https://code.visualstudio.com/docs/remote/containers#_quick-start-try-a-dev-container)), the environment construction will start. | ||
|
|
||
| #### Notes | ||
| - If you want to change the settings, modify `'.devcontainer/devcontainer.json `'. Please refer to [devcontainer.json reference](https://code.visualstudio.com/docs/remote/containers#_devcontainerjson-reference) for more details. | ||
| - The extension "ESLint" is only valid when executing Remote Container. Please add it to the `'extensions `' of `'devcontainer.json `' if necessary. | ||
| - A detailed procedure can be found [here（external site）] (https://code.visualstudio.com/docs/remote/containers#_managing-extensions). | ||
| - When rebuilding the development environment, please execute “Rebuild Container” which can be found at the lower left. | ||
|
|
||
| ### 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` 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 | https://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 | | ||
| | Staging | staging | https://stg-covid19-tokyo.netlify.com/ | For final confirmation before production. Non-admin pull requests are prohibited | | ||
| Production | master | https://stopcovid19.metro.tokyo.lg.jp/ | Pull Requests other than Administrators are prohibited | | ||
|
|
||
| #### Branch used by the system | ||
| | Purpose | Branch | Confirmation URL | Remarks | | ||
| | ---- | -------- | ---- | ---- | | ||
| | Production site HTML | production | https://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_ogp | None | For updating OGP | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters