Skip to content

Commit

Permalink
Merge pull request stopcovid19-okayama#3705 from masanori1102/feature…
Browse files Browse the repository at this point in the history 
…/3322-separate-french-for-developers-from-README-into-another-file

refs stopcovid19-okayama#3322 フランス語のREADME.mdから、「開発者向け情報」を別ファイルに分ける
  • Loading branch information
@nyagihime
nyagihime authored Apr 28, 2020
2 parents 7921b7c + 47d9c16 commit 7433d22
Show file tree
Hide file tree
Showing 2 changed files with 207 additions and 97 deletions.
206 changes: 206 additions & 0 deletions docs/fr/FOR_DEVELOPERS.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,206 @@
# Pour les développeurs

## 1. Comment préparer l'environement de développement

[PLEASE TRANSLATE ME]

Install the following application to the environment for development.

| Application name | Application version(Fill in only if specified) | Installation conditions |
| ------- | ------- | ------- |
|[Node.js](https://nodejs.org/fr/)|10.19.0 or plus récent|Required|
|[Visual Studio Code](https://code.visualstudio.com/)| |If you use Visual Studio Code|
|[yarn](https://classic.yarnpkg.com/fr/)| |When executing this program with `yarn`|
|[docker compose](https://docs.docker.com/compose/install/)| |When executing this program with `docker compose`|
|[Vagrant](https://www.vagrantup.com/)| |When executing this program with `Vagrant`|

### 1-1. Extensions for Visual Studio Code

To use Visual Studio Code, install the following extension.

| Extensions | Installation conditions |
| ------- | ------- |
|[ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)|Any|
|[Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur)|Any|
|[TSLint](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-typescript-tslint-plugin)|Any|
|[Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome)|Any|
|[Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack)|When developing with Visual Studio Code and Remote Containers|

---

## 2. Run this program

The command is executed in the working copy root directory.

[/PLEASE TRANSLATE ME]

### 2-1. En utilisant `yarn`

#### 2-1-1. Installe les dépendances

```bash
# installe les dépendances
$ yarn install
```

[PLEASE TRANSLATE ME]

#### 2-1-2. Run this program

After executing the following command, you can check the program under development by accessing http://localhost:3000 .

##### 2-1-2-1. Normal

[/PLEASE TRANSLATE ME]

```bash
# Sers le site avec hot-reload à l'adresse localhost:3000
$ yarn dev
```

[PLEASE TRANSLATE ME]

##### 2-1-2-2. Faster

You can disable accessibility auditing, which would make your local server faster.

```bash
# serve with hot reload at localhost:3000
$ yarn dev-no-axe
```

### 2-1-3. Troubleshoot

[/PLEASE TRANSLATE ME]

#### 2-1-3-1. Comment résoudre l'erreur `Cannot find module ****`

[PLEASE TRANSLATE ME]

Build the dependency again and run the program.

[/PLEASE TRANSLATE ME]

### 2-2. En utilisant `docker compose`

[PLEASE TRANSLATE ME]

#### 2-2-1. Install dependencies and run this program

After executing the following command, you can check the program under development by accessing http://localhost:3000 .

[/PLEASE TRANSLATE ME]

```bash
# Sers le site avec hot-reload à l'adresse localhost:3000
$ docker-compose up --build
```

[PLEASE TRANSLATE ME]

### 2-2-2. Troubleshoot

[/PLEASE TRANSLATE ME]

#### 2-2-2-1. Comment résoudre l'erreur `Cannot find module ****`

[PLEASE TRANSLATE ME]

Stop the program and execute the following command.

[/PLEASE TRANSLATE ME]

```bash
$ docker-compose run --rm app yarn install
```

### 2-3. En utilisant `Vagrant`

[PLEASE TRANSLATE ME]

#### 2-3-1. Install dependencies and run this program

After executing the following command, you can check the program under development by accessing http://localhost:3000 .

[/PLEASE TRANSLATE ME]

```bash
# Sers le site avec hot-reload à l'adresse localhost:3000
$ vagrant up
```

[PLEASE TRANSLATE ME]

### 2-4. When developing with Visual Studio Code and Remote Containers

#### 2-4-1. Install dependencies and run this program

If you select the “Open Folder in Container” root of this repository (as seen in the lower left [Quick start: Try a dev container (external site)](https://code.visualstudio.com/docs/remote/containers#_quick-start-try-a-dev-container)), the environment construction will start.

You can check the program under development by accessing http://localhost:3000 after building the environment.

#### 2-4-2. 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/devcontainer.json` if necessary.
- A detailed procedure can be found [Managing extensions (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.

[/PLEASE TRANSLATE ME]

---

## 3. Detecter le type d'environnement

Dans l'environnement de production, la valeur `'production'` est attribuée à la variable `process.env.GENERATE_ENV`, le reste du temps la valeur assignée est `'development'`.
Veuillez utiliser cette variable pour détecter quel type d'environnement est executé.

---

## 4. Deployer vers les environnements Staging & Production

[PLEASE TRANSLATE ME]

When the branch listed in the left column of the table below is updated, the branch and website will be updated automatically.

| branch | A branch where HTML is built and updated | Website updated |
| ---- | ---- | ---- |
|`master`|`production`|The production site https://stopcovid19.metro.tokyo.lg.jp/|
|`staging`|`gh-pages`|The staging site https://stg-covid19-tokyo.netlify.app/|
|`development`|`dev-pages`|The development site https://dev-covid19-tokyo.netlify.app/|

[/PLEASE TRANSLATE ME]

---

## 5. Regles sur les branches

Les Pull Request sont permises seulement sur `development`.
Veuillez utiliser le schema suivant pour nommer vos Pull Request.

[PLEASE TRANSLATE ME]

| Types of changes | Naming rules for the branch |
| ---- | ---- |
|Nouvelle feature|`feature/#{ISSUE_ID}-#{branch_title_name}`|
|Hotfix|`hotfix/#{ISSUE_ID}-#{branch_title_name}`|

[/PLEASE TRANSLATE ME]

### 5-1. Branches basiques

| But | Branche | URL | People who can make pull requests | Notes |
| ---- | ---- | ---- | ---- | ---- |
| Development | development | https://dev-covid19-tokyo.netlify.app/ | All developers | Branche de base. Faites votre Pull Request ici. |
| Staging | staging | https://stg-covid19-tokyo.netlify.app/ | Only administrators | Pour confirmation avant production. Pull request d'utilisateurs non-admin sont defendues. |
| Production | master | https://stopcovid19.metro.tokyo.lg.jp/ | Only administrators | Pull request d'utilisateurs non-admin sont defendues. |

[/PLEASE TRANSLATE ME]

### 5-2. Branches utilisees par le systeme

| But | Branche | URL | Notes |
| ---- | -------- | ---- | ---- |
| Production site HTML | production | https://stopcovid19.metro.tokyo.lg.jp/ | Place ou les pages HTML statiques sont stockees. |
| Staging site HTML | gh-pages | https://stg-covid19-tokyo.netlify.app/ | Ou trouver l'HTML statiquement construit. |
| Dossier de travail OGP | deploy / new_ogp | None | Pour mettre a jour OGP |
98 changes: 1 addition & 97 deletions docs/fr/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,104 +22,8 @@ Ce logiciel est sous [license MIT](./../../LICENSE.txt).

## Pour les développeurs

### Comment préparer l'environement de développement

- Version de Node.js requise: 10.19.0 or plus récent

**En utilisant yarn**
```bash
# installe les dépendances
$ yarn install

# Sers le site avec hot-reload à l'adresse localhost:3000
$ yarn dev
```


[PLEASE TRANSLATE ME]

**アクセシビリティチェック（vue-axe）を無効にする方法**

- 開発用ローカルサーバが重い場合、以下のようにアクセシビリティチェックを無効にして起動することができます。

```bash
# serve with hot reload at localhost:3000
$ yarn dev-no-axe
```
Please check [Pour les développeurs](./FOR_DEVELOPERS.md) doc.

[/PLEASE TRANSLATE ME]


**En utilisant docker**
```bash
# Sers le site avec hot-reload à l'adresse localhost:3000
$ docker-compose up --build
```

### Comment résoudre l'erreur `Cannot find module ****`

**En utilisant yarn**
```bash
$ yarn install
```

**En utilisant docker**
```bash
$ docker-compose run --rm app yarn install
```

[PLEASE TRANSLATE ME]
### VSCode + Remote Containersで開発する場合

1. VSCodeの拡張機能「[Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack)」を導入します。
2. [この画像（外部サイト）](https://code.visualstudio.com/docs/remote/containers#_quick-start-try-a-dev-container)のように左下部の「Open Folder in Container」でこのリポジトリのルートを選択すれば環境構築が始まります。

#### Topic
- 設定を変更したい場合は、`.devcontainer/devcontainer.json`を修正してください。
詳細は[devcontainer.jsonのリファレンス](https://code.visualstudio.com/docs/remote/containers#_devcontainerjson-reference)を参照してください。
- Remote Container実行時のみ有効な拡張機能「ESLint」を導入していますが、必要に応じて`devcontainer.json`の`extensions`に追加してください。
詳細な手順は[こちら（外部サイト）](https://code.visualstudio.com/docs/remote/containers#_managing-extensions)を参照してください。
- 開発環境を再構築する場合は、左下部の「Rebuild Container」を実行してください。

[/PLEASE TRANSLATE ME]

### Detecter le type d'environnement

Dans l'environnement de production, la valeur `'production'` est attribuée à la variable `process.env.GENERATE_ENV`, le reste du temps la valeur assignée est `'development'`.
Veuillez utiliser cette variable pour détecter quel type d'environnement est executé.

### Deployer vers les environnements Staging & Production

Quand la branche `master` est mise-à-jour, les fichiers HTML sont automatiquement construits vers la branche `production`,
et le site production (https://stopcovid19.metro.tokyo.lg.jp/) est aussi mis-à-jour.

Quand la branche `staging` est mise-à-jour, les fichiers HTML sont automatiquement construits vers la branche `gh-pages`,
et le site staging (https://stg-covid19-tokyo.netlify.app/) est aussi mis-à-jour.

Quand la branche `development` est mise-à-jour, les fichiers HTML sont automatiquement construits vers la branche `dev-page`,
et le site development (https://dev-covid19-tokyo.netlify.app/) est aussi mis-à-jour.

### Regles sur les branches

Les Pull Request sont permises seulement sur `development`, et `dev-hotfix`.
Veuillez utiliser le schema suivant pour nommer vos Pull Request:

Nouvelle feature: feature/#{ISSUE_ID}-#{nom_de_la_branche}
Hotfix: hotfix/#{ISSUE_ID}-{nom_de_la_branche}

#### Branches basiques

| But | Branche | URL | Notes |
| ---- | -------- | ---- | ---- |
| Development | development | https://dev-covid19-tokyo.netlify.app/ | Branche de base. Faites votre Pull Request ici. |
| Hotfix branch | dev-hotfix | None | Fixs qui devraient etre appliques a l'environnement de production rapidement. Utilisez cette branche si demande par l'administrateur. |
| Staging | staging | https://stg-covid19-tokyo.netlify.app/ | Pour confirmation avant production. Pull request d'utilisateurs non-admin sont defendues. |
Production | master | https://stopcovid19.metro.tokyo.lg.jp/ | Pull request d'utilisateurs non-admin sont defendues. |

#### Branches utilisees par le systeme

| But | Branche | URL | Notes |
| ---- | -------- | ---- | ---- |
| Production site HTML | production | https://stopcovid19.metro.tokyo.lg.jp/ | Place ou les pages HTML statiques sont stockees. |
| Staging site HTML | gh-pages | https://stg-covid19-tokyo.netlify.app/ | Ou trouver l'HTML statiquement construit. |
| Dossier de travail OGP | deploy / new_ogp | None | Pour mettre a jour OGP |

0 comments on commit 7433d22

Please sign in to comment.