Tokyo-Metro-Gov/covid19 项目开发环境搭建与运行指南

项目概述

Tokyo-Metro-Gov/covid19 是一个基于Web的疫情信息展示系统，主要用于东京都政府向公众提供公共卫生相关数据和信息。该项目采用现代前端技术栈开发，支持多种开发环境配置方式。

开发环境准备

基础软件要求

开发本项目需要安装以下基础软件：

1. Node.js：版本18.14.2或更高，这是运行JavaScript代码的运行时环境
2. 包管理工具：推荐使用yarn进行依赖管理
3. 代码编辑器：Visual Studio Code是推荐的开发工具

Visual Studio Code扩展推荐

为提高开发效率，建议安装以下VS Code扩展：

• ESLint：JavaScript代码质量检查工具
• Vetur：Vue.js开发支持工具
• TSLint：TypeScript代码检查工具
• Debugger for Chrome：Chrome浏览器调试工具
• Remote Development：远程开发支持扩展包

项目运行方式

本项目支持多种运行方式，开发者可根据自身需求选择：

1. 使用yarn运行

步骤1：安装依赖

yarn install

步骤2：启动开发服务器

yarn dev

启动后访问 http://localhost:3000 即可查看项目

轻量模式：如果开发服务器运行缓慢，可禁用vue-axe检查：

yarn dev-no-axe

常见问题：如遇模块找不到错误，重新安装依赖通常可解决问题

2. 使用Docker Compose运行

启动命令：

docker compose up --build

依赖问题解决：如遇依赖问题，可运行：

docker compose run --rm app yarn install

3. 使用Vagrant运行

启动命令：

vagrant up

4. 使用VS Code Remote Containers开发

1. 使用"Open Folder in Container"功能打开项目根目录
2. 等待环境自动构建完成
3. 访问 http://localhost:3000 查看项目

配置调整：可通过修改.devcontainer/devcontainer.json文件自定义开发容器配置

环境与部署管理

环境判断

项目通过process.env.GENERATE_ENV变量区分环境：

• 生产环境：值为'production'
• 其他环境：值为'development'

部署流程

项目采用自动化部署策略，不同分支对应不同环境：

分支	对应环境	访问地址
master	生产环境	东京都政府官方公共卫生网站
staging	预发布环境	Firebase托管的预发布站点
development	开发环境	Firebase托管的开发站点

分支管理规范

项目采用严格的分支管理策略：

分支命名规则

1. 功能开发分支：feature/#{问题ID}-{分支描述}
2. 紧急修复分支：hotfix/#{问题ID}-{分支描述}

主要分支用途

分支	用途	提交权限
development	主要开发分支	所有开发者
staging	预发布验证	仅管理员
master	生产环境	仅管理员

数据处理与依赖管理

数据JSON处理

当data目录下的JSON数据结构变更时，需要重新生成类型定义：

yarn generate-data-converters

此命令会更新libraries/auto_generated目录下的自动生成代码。

依赖管理

项目使用Renovate进行依赖更新管理，Node.js版本更新需手动进行：

1. 查找并替换所有版本号引用
2. 本地安装指定Node.js版本
3. 重新生成yarn.lock文件并提交

最佳实践建议

1. 开发环境选择：本地开发推荐使用yarn方式，跨平台或环境隔离需求可使用Docker
2. 代码质量：充分利用ESLint等工具保持代码规范
3. 分支管理：严格遵循分支规范，避免直接向受保护分支提交代码
4. 数据变更：JSON结构变更后务必运行生成命令更新类型定义

通过遵循本指南，开发者可以快速搭建开发环境并参与到Tokyo-Metro-Gov/covid19项目的开发工作中。