如果您能對 Issues 中做出各式各樣的修正協助,我們將不勝感激。
詳情請洽如何貢獻。
詳情請洽建立網站的行動原則。
本軟體採 MIT 授權條款釋出。
請參考此連結
有要幫忙翻譯的話,請參考 這個文件 。
- Node.js 版本最低需求:10.19.0 以上
使用 yarn 的做法
# install dependencies
$ yarn install
# serve with hot reload at localhost:3000
$ yarn dev
使用 docker compose 的做法
# serve with hot reload at localhost:3000
$ docker-compose up --build
使用 Vagrant 的做法
# serve with hot reload at localhost:3000
$ vagrant up
使用 yarn 的做法
$ yarn install
使用 docker compose 的做法
$ docker-compose run --rm app yarn install
- 安裝 VSCode 的擴充套件「Remote Development」。
- 如同 這個圖像(外部連結)點擊左下角的 「Open Folder in Container」 後選擇 Repository 的資料夾路徑開始建立環境。
- 如果想要變更設定,請更改
.devcontainer/devcontainer.json
這隻檔案。 詳細請參考 devcontainer.json的參考值。 - Remote Container 啟動時擴充套件只有導入 「ESlint」、如果有必要,請在
devcontainer.json
的extensions
中新增。 詳細的步驟請參考 這裡(外部連結)。 - 如果要重新建立開發環境,請執行左下角的 「Rebuild Container」。
關於 process.env.GENERATE_ENV
這個值 ,生產環境為 'production'
,除此之外為 'development'
。
如果只想要在測試環境中執行的話,請利用這個值作為參考。
當 master
分支被更新時,HTML 檔案將會在 production
分支中被 build 起來,然後正式版網站 https://stopcovid19.metro.tokyo.lg.jp/ 會被更新。
當 staging
分支被更新時,HTML 檔案將會在 gh-pages
分支中被 build 起來,然後 Staging 版網站 https://stg-covid19-tokyo.netlify.com/ 會被更新。
當 development
分支被更新時,HTML 檔案將會在 dev-pages
分支中被 build 起來,然後開發版網站 https://dev-covid19-tokyo.netlify.com/ 會被更新。
只允許推送 Pull Request 到 development
跟 dev-hotfix
。
在推送 Pull Request 時,請依照以下命名規則為您的分支命名
新增功能: feature/#{ISSUE_ID}-#{branch_title_name}
Hotfix: hotfix/#{ISSUE_ID}-{branch_title_name}
目的 | 分支 | 預覽用 URL | 備註 |
---|---|---|---|
開發 | development | https://dev-covid19-tokyo.netlify.com/ | 基本上請推送 Pull Request 到這裡 |
緊急修復 | dev-hotfix | 無 | 對於正式版的緊急修復。 在管理員的要求下使用。 |
正式版預覽 | staging | https://stg-covid19-tokyo.netlify.com/ | 對於正式版釋出前的最終確認,禁止管理員以外的人推送 Pull Request。 |
正式版 | master | https://stopcovid19.metro.tokyo.lg.jp/ | 禁止管理員以外的人推送 Pull Request |
目的 | 分支 | 預覽用 URL | 備註 |
---|---|---|---|
正式網站 HTML | production | https://stopcovid19.metro.tokyo.lg.jp/ | 生成靜態網站 HTML 的位置 |
正式版預覽 HTML | gh-pages | https://stg-covid19-tokyo.netlify.com/ | 生成靜態網站 HTML 的位置 |
OGP 工作用 | deploy / new_ogp | 無 | OGP 更新用 |