instantgamingcom/fakes3

Instant Gaming 本地开发环境 Docker 配置

目录

• 安装
• 贡献指南
• SSL证书配置方案
  • Chrome (Linux)
  • Safari (Mac)
• 命令行使用
  • PHP Unit 测试
• 资产管理
• 数据管理
• 实用信息
  • 访问地址
  • phpMyAdmin
  • Docker 文件位置
  • 后台权限配置
  • SASS Lint 规则
  • 本地发送移动通知
  • XHProf 调试

安装

1. 克隆本仓库，路径无特殊要求。
2. 创建 ig-data 和 ig-data/images 目录，形成如下文件夹结构：

your-folder/
├── ig-data/          <--- 需创建
│   └── images/       <--- 需创建
└── instant-gaming/
    ├── .github/
    ├── lib/
    └── ...

3. 安装 Docker 并确保非 root 用户可使用：
   • Linux：参考 Docker 官方文档（安装后需重启！）
4. 复制 ufo/tools/docker/docker-compose.dev-local.yml.example 为 ufo/tools/docker/docker-compose.dev-local.yml（移除 .example 后缀）
5. 编辑该文件配置路径：
   在 volumes 下，将 nfsmount:/var/www/instant-gaming/current 中 : 左侧的 nfsmount 替换为本地 instant-gaming 仓库的实际路径。
6. 向相关人员获取 ufo/tools/docker/ig-resources/ 服务凭证目录。
7. 在 /etc/hosts 文件末尾添加以下内容：

# Instant Gaming local
127.0.0.1       local.instant-gaming.com local.abonnement-xbox-live.com
127.0.0.1       s1.local.gaming-cdn.com s2.local.gaming-cdn.com s3.local.gaming-cdn.com
127.0.0.1       ig.team.local local.fb-analytics.com fakes3

若使用 OSX 系统，需额外添加（在上述内容之后）：

# Instant Gaming local for OSX env (IPv6)
::1       local.instant-gaming.com local.abonnement-xbox-live.com
::1       s1.local.gaming-cdn.com s2.local.gaming-cdn.com s3.local.gaming-cdn.com
::1       ig.team.local local.fb-analytics.com fakes3

8. 运行以下命令构建容器：
   ./ufo/tools/docker/dev.sh
9. 向相关人员获取最小化数据库备份并导入（参见「实用信息」部分了解数据库访问方式）。
10. 需使用生产环境数据更新数据库，参见「数据管理 > 产品与语言」。
11. 开始工作前可能需要一些测试订单，参见「数据管理 > 订单」。

贡献指南

• 请为修改创建分支，分支命名规则：
  • feature/456-my-feature-name - 新功能
  • fix/345-my-fix-name - 问题修复
• 示例：git checkout -b feature/123-add-a-hidden-zelda-game-on-404-page
• 请频繁提交和推送修改，以便他人了解你的工作进度：
  git push --set-upstream origin feature/my-feature-name
• 完成后，在 GitHub 创建详细的 Pull Request，需包含：
  • 足够的描述（如 US 链接、实现说明及选择理由）
  • 至少一位相关审核人（右上角指定）
  • 确保持续集成通过，以便 PR 就绪后可直接合并。若 PHPCS 检查失败，通常可通过 ./ufo/tools/docker/dev.sh fix 修复大部分问题。

SSL证书配置方案

需执行以下步骤以允许本地 instant-gaming 网站的 SSL 证书。

Chrome (Linux)

1. 点击网站地址左侧的锁图标下载证书。
2. 点击「证书」。
3. 切换到「详细信息」标签页。
4. 点击弹窗底部的「导出」按钮。
5. 保存为「PKCS #7，单个证书」格式。
6. 执行以下命令：

bash
sudo apt-get update
sudo apt-get install libnss3-tools

bash
certutil -d sql:$HOME/.pki/nssdb -A -t "P,," -n [导出的证书路径] -i [导出的证书路径]

bash
certutil -d sql:$HOME/.pki/nssdb -L

7. 重启浏览器。

Safari (Mac)

Mac OSX 系统无法从 Chrome 下载证书，需使用其他浏览器：

1. 打开 Safari 并访问 https://ig.team.local/。
2. 点击 URL 旁的锁图标。
3. 点击「显示证书」。
4. 按住 Option 键点击证书图标，拖拽至 TextEdit 新文件中。
5. 文件应以 -----BEGIN CERTIFICATE----- 开头。
6. 复制从 -----BEGIN CERTIFICATE----- 到 -----END CERTIFICATE-----（含首尾）的所有内容。
7. 保存为 .pem 扩展名文件（若 TextEdit 保存失败，可使用 Sublime Text 或 PhpStorm 等编辑器）。
8. 打开「应用程序 > 实用工具 > 钥匙串访问」。
9. 执行「文件 > 导入项目」，选择保存的证书。
10. 在钥匙串访问中，进入「证书」，双击 local.instant-gaming.com，点击「信任」，将「使用此证书时」设置为「始终信任」。
11. 返回 https://ig.team.local/，点击「Price Watcher」。页面右下角的红色「Connecting」应变为绿色「Connected」。可能需要重启电脑生效。

命令行使用

主要脚本为 ./ufo/tools/docker/dev.sh，用于启动/停止容器或执行脚本。

启动容器：

bash
./ufo/tools/docker/dev.sh

注意：首次安装时，NPM 会在后台安装 node_modules 目录中的依赖包，约需 5 分钟后开发环境中的资产（JS/CSS）才可访问。

查看帮助信息：

bash
./ufo/tools/docker/dev.sh help

PHP Unit 测试

运行单元测试：

bash
./ufo/tools/docker/dev.sh php tools/vendor/bin/phpunit

资产管理

使用 Webpack 处理资产（SASS 和 JS）。webpack 容器会监听文件变化，修改文件后相关资产会在 1~2 秒内重新生成。

查看 Webpack 输出日志：

bash
./ufo/tools/docker/dev.sh logs -f webpack

数据管理

产品与语言

如需与生产环境数据同步，执行以下命令：

bash
./ufo/tools/docker/dev.sh php ufo/tools/tmp/update_dev_env.php --update-all

若生产环境权限不足，需联系相关人员。

订单

开发环境默认无数据，可通过 PHP 脚本生成测试订单：

1. 在前台创建用户账户（可能需要额外 2 个测试账户）。
2. 执行命令：

bash
./ufo/tools/docker/dev.sh php ufo/tools/tmp/populate_stock_and_orders.php --populate

实用信息

访问地址

• 前台：[***]
• 后台：[***]

phpMyAdmin

• 地址：[***]
• 用户名：root
• 密码：root

Docker 文件位置

所有 Docker 相关文件位于 ufo/tools/docker 目录。

后台权限配置

本地环境权限可能受限，可通过以下步骤覆盖个人权限：

1. 创建文件 ufo/permissions.local.php。
2. 复制以下代码：

php
<?php

use InstantGaming\Core\Security\Permission\{Staff, TeamPermission, Permission};

$employees[Staff::STAFF_YOUR_NAME]['permissions'] = [
    TeamPermission::DEVTEAM_READ,
    TeamPermission::DEVTEAM_ADVANCED,
    // 在此添加其他权限
];

3. 将 STAFF_YOUR_NAME 替换为以 STAFF_ 开头的个人名称常量。
4. 刷新本地后台页面，权限将更新。

SASS Lint 规则

查看所有可用规则：

• CSS（含 SASS）：[***]
• SASS 专用：https://github.com/bjankord/stylelint-config-sass-guidelines%EF%BC%88%E8%A7%84%E5%88%99%E9%9C%80%E4%BB%A5 sass/ 为前缀）

本地发送移动通知

参考以下文档：
[***]

XHProf 调试

1. 在 ufo/tools/docker/docker-compose.dev-local.yml 文件中，为 php-fpm 服务添加环境变量：
   XHPROF_PROFILER=1
2. 重启容器。

每次请求都会被分析，分析结果可通过以下地址访问：
[***]