LANager 开源项目教程

LANager 开源项目教程

1. 项目介绍

LANager 是一个专为局域网派对设计的管理 Web 应用程序。它旨在通过提供一系列功能，使局域网派对对参与者和组织者都更加愉快和有序。LANager 的主要功能包括：

• 社交与参与：鼓励参与者之间的社交互动。
• 游戏追踪：实时更新参与者正在玩的游戏，数据来自 Steam。
• 活动时间表：提供活动时间表，让参与者了解即将发生的事件。
• 成就系统：组织者可以创建并颁发成就给参与者。
• 参与者档案：显示参与者的 Steam 档案和游戏历史。
• 共同游戏：显示参与者之间共同玩过的游戏。
• 最近游戏：显示参与者最近玩过的游戏。
• 信息广播：通过幻灯片展示当前游戏和即将发生的事件，适用于场地内的电视或投影仪。
• 指南：提供场地设施、规则或游戏指南等信息。
• 链接：链接到其他网站，如组织网站或游戏统计页面。

2. 项目快速启动

环境要求

• 互联网访问
• Docker Engine
• Docker Compose

快速启动步骤

1. 克隆项目：

   git clone https://github.com/zeropingheroes/lanager-docker-compose
   

2. 配置环境变量：

   cd lanager-docker-compose
   cp .env.example .env
   nano .env
   

   在 .env 文件中设置以下配置项：

   • APP_KEY：设置为 base64: 后跟一个随机生成的 32 字符 base64 字符串。
   • APP_URL：设置为访问 LANager 的 URL，不带尾部斜杠，例如 https://example.com。
   • APP_TIMEZONE：设置为所在时区。
   • STEAM_API_KEY：设置为你的 Steam API Key。
   • DB_PASSWORD：设置为一个随机生成的密码。
   • DB_ROOT_PASSWORD：设置为另一个随机生成的密码。

3. 启动应用：

   docker-compose up --detach
   

4. 检查应用状态：

   docker ps --filter name=lanager
   

5. 初始化数据库：

   ./initialise-database.sh
   

6. 访问应用： LANager 现在应该可以通过 http://localhost 或你在 APP_URL 中指定的 URL 访问。

3. 应用案例和最佳实践

应用案例

• 局域网派对管理：LANager 可以用于管理大型或小型的局域网派对，帮助组织者跟踪参与者的活动，提供实时更新的游戏信息和活动时间表。
• 游戏社区活动：游戏社区可以使用 LANager 来组织和跟踪社区内的游戏活动，如比赛、聚会等。

最佳实践

• 定期备份：使用 ./backup.sh 脚本定期备份配置、数据库数据和上传的图像。
• 调试模式：在 .env 文件中启用调试模式 (APP_ENV=staging 和 APP_DEBUG=true) 以进行故障排除，完成后记得关闭。
• 自定义导航栏：通过 ⚙ > Navigation 自定义导航栏链接，使其更符合组织需求。

4. 典型生态项目

• Docker：用于容器化部署，简化环境配置和依赖管理。
• Steam API：用于获取参与者的游戏数据和 Steam 档案信息。
• Markdown：用于格式化指南和活动描述，提供更好的阅读体验。
• Git：用于版本控制和协作开发。

通过以上步骤，你可以快速启动并使用 LANager 来管理你的局域网派对或游戏社区活动。