veteransaffairscanada/vac-benefits-directory

VAC福利目录

概述和主要用途

由加拿大退伍军人事务部(VAC)和加拿大数字服务(CDS)联合开发的VAC福利目录应用，用于提供福利信息查询与相关服务。该应用当前部署于[***]

核心功能和特性

• 从Airtable加载福利数据、翻译内容等核心信息
• 集成Google Maps实现地图页面的位置查询功能
• 支持反馈表单数据写入Airtable数据库
• 通过Sentry捕获并记录浏览器错误
• 集成Google Analytics进行应用使用情况跟踪
• 从GitHub收集数据用于统计页面展示
• 支持Slack部署通知功能

使用场景和适用范围

• 退伍军人及相关人员查询VAC福利信息
• 开发人员进行本地开发和功能测试
• 测试环境验证新功能和配置
• 生产环境部署以提供公共福利查询服务

环境变量配置

应用运行需配置以下环境变量，部分变量在生产、本地开发或测试环境中为必需。注意：CDS Docker镜像是公开的，不应在镜像中包含任何敏感（写权限）密钥。

本地添加环境变量（OS X）

1. 打开终端，运行：nano ~/.bash_profile（若使用zsh shell，运行nano ~/.zshrc）
2. 添加行：export GOOGLE_MAPS_KEY="foo"（将"foo"替换为实际值）
3. 按[ctrl] + x，输入y保存
4. 运行source ~/.bash_profile（或source ~/.zshrc）使配置生效
5. 运行echo $GOOGLE_MAPS_KEY验证是否设置成功

本地添加环境变量（Windows 7）

1. 开始菜单 > 控制面板 > 用户账户 > 用户账户 > 更改我的环境变量 > 新建...
2. 示例配置：变量名 = AIRTABLE_READ_KEY，联系项目其他开发人员获取当前使用的值
3. 重启命令提示符，运行echo %AIRTABLE_READ_KEY%验证是否设置成功

向源代码添加新环境变量

1. 按上述步骤在本地添加环境变量
2. 在源代码中通过process.env.YOUR_VARIABLE_NAME引用
3. 在Dockerfile中添加以下行：

   ARG YOUR_VARIABLE_NAME
   ENV YOUR_VARIABLE_NAME ${YOUR_VARIABLE_NAME}
   

4. 在config.yml中添加构建参数：--build-arg YOUR_VARIABLE_NAME="${YOUR_VARIABLE_NAME}"
5. 通过CircleCI web界面添加环境变量：访问[***] > 设置 > 环境变量
6. 通过Heroku web界面添加环境变量，需添加到生产应用及拉取请求审核基于的应用（如vac-poc-staging）：进入应用 > 设置 > "Reveal Config Vars" > 设置变量
7. 在app.json的env对象中添加"YOUR_VARIABLE_NAME": { "required": true }

快速启动指南

OS X

1. 按上述说明设置适当的环境变量
2. 安装开发环境：
   • Homebrew
   • Node.js（brew install node）
   • Yarn（npm i yarn）
3. 克隆仓库：git clone git@github.com:cds-snc/vac-benefits-directory.git
4. 在本地仓库目录中：
   • yarn install（安装依赖）
   • yarn dev（启动本地服务器）

Windows

1. 按上述说明设置适当的环境变量
2. 下载9.0或更高版本的Node.js（因.msi可能被阻止，建议下载.zip格式）
3. 配置Node.js环境变量：

   开始菜单 > 控制面板 > 用户账户 > 用户账户 > 更改我的环境变量 > 选择Path > 编辑 > 添加Node.js安装路径（如C:\Node），用分号分隔其他条目

4. 安装Yarn：npm install -g yarn
5. 在项目主目录中运行：yarn install（安装依赖，耗时较长，尤其是构建包时）
6. 运行yarn dev（在项目文件夹中启动本地服务器）
7. 若遇到语法错误，可能是缺少依赖包，可尝试删除node_modules文件夹后重新运行yarn install

参考资源

本应用使用以下技术资源：

• NextJS [***]
• Jest https://***.github.io/jest/
• Prettier [***]