unillett/impact

概述

multIMedia interface: Presentation – Analysis – CommenT（多媒体界面：展示-分析-评论）是一个基于Laravel 12和React组件的应用程序。

使用Docker开发

Docker安装

必须安装正常工作的https://docs.docker.com/engine/install/。

环境文件

请确保将example.env文件复制并重命名为**.env**：

bash
cp docker/example.env docker/.env

如有需要可替换值，但默认值适用于本地开发。

同时，请确保将docker-compose.override.yml.dev文件复制并重命名为docker-compose.override.yml：

bash
cp docker-compose.override.yml.dev docker-compose.override.yml

如有需要可替换值，但默认值适用于本地开发。

编辑hosts文件

编辑hosts文件，将impact.lan指向您的Docker主机。

安装与配置

构建并运行此项目的所有容器：

bash
docker-compose up

（如果希望在后台运行并隐藏日志，可添加-d参数）

填充数据库

首次运行应用程序时，需要用初始数据填充数据库：

bash
docker exec impact-app php artisan db:seed

如需完全清空数据库并重新填充新数据，可使用以下命令：

bash
docker exec impact-app php artisan migrate:fresh --seed

资源文件

容器构建时会编译资源，但如果需要重新编译，可使用以下命令：

bash
docker exec impact-app npm run dev

如需监听文件变化：

bash
docker exec impact-app npm run watch

前端访问

主应用

通过以下链接访问主应用：
[***]

• 用户名：*** / 密码：password

Telescope（调试工具）

通过以下链接访问调试工具：
[***]

phpMyAdmin（数据库管理）

通过以下链接访问数据库：
[***]

• 服务器：impact-mysql
• 用户名：user
• 密码：password

MailHog（邮件测试）

通过以下链接访问邮件：
[***]

或通过以下链接获取JSON格式的邮件消息：
[***]

PHP代码风格

CI过程中会检查所有PHP文件的代码风格问题。如需预先进行模拟检查，使用以下命令：

bash
docker exec impact-app ./vendor/bin/pint --test

如需自动修复问题：

bash
docker exec impact-app ./vendor/bin/pint

测试

单元/功能测试

运行完整测试套件：

bash
docker exec -it impact-app php artisan test

浏览器测试

需先安装Chrome Driver：

bash
docker exec -it impact-app php artisan dusk:chrome-driver

运行完整测试套件：

bash
docker exec -it impact-app php artisan dusk --env=testing

运行特定测试类：

bash
docker exec -it impact-app php artisan dusk tests/Browser/MyTest.php --env=testing

如需在浏览器中查看集成测试过程，访问[***]，点击“Sessions”，找到对应测试会话旁的摄像头图标，点击打开VNC查看器（密码为“secret”）。

使用Docker部署

环境文件

复制并重命名以下环境文件：

bash
cp docker/example.env docker/.env
cp site/.env.example site/.env

需替换值，默认值不适用于生产环境。

要通过Shibboleth进行身份验证，需在site/.env中取消注释并设置SHIB_HOSTNAME和SHIB_CONTACT变量，否则只能使用本地身份验证。

同时，请确保将docker-compose.override.yml.prod文件复制并重命名为docker-compose.override.yml：

bash
cp docker-compose.override.yml.prod docker-compose.override.yml

如有需要可替换值，但默认值适用于生产环境。

安装与配置

构建并运行此项目的所有容器：

bash
docker compose up -d

反向代理

使用反向代理配置将URL映射到端口8787。

Docker镜像

GitHub Actions工作流基于以下事件生成Docker镜像标签：

• 推送到development分支：{service}-dev-latest、{service}-stage-latest、{service}-stage-<sha>-<timestamp>（不可变）
• 推送到master分支：{service}-latest
• 推送Git标签：{service}-vX.Y.Z（不可变）

每周定时任务：

• 创建更新的 staging 镜像：{service}-stage-<sha>-<timestamp>（不可变）
• 创建更新的生产候选镜像：{service}-vX.Y.Z-<sha>-<timestamp>（不可变）

所有不可变标签均提交至https://github.com/unil-lettres/k8s仓库。

错误跟踪器

https://www.bugsnag.com

Helm

本项目的Helm图表可在https://github.com/unil-lettres/k8s的`impact`目录中获取。