eventyay/open-event-frontend

Open Event Frontend

!Open Event Frontend

https://github.com/fossasia/open-event-frontend/workflows/CI/badge.svg?branch=development](https://github.com/fossasia/open-event-frontend/actions?query=workflow%3Aci) ![Netlify]([] ![Codacy Badge]([] ![codecov]([] ![Known Vulnerabilities]([] ![Weblate]([] ![Gitter]([] ![Mailing]([] ![ Follow]([***]

镜像概述和主要用途

Open Event Frontend是Open Event Server的前端界面，用于事件管理、展示和用户交互。它为活动组织者提供事件创建、管理功能，为参与者提供事件浏览、注册等服务，支持多平台部署，可作为独立应用或与Open Event Server后端配合使用。

核心功能和特性

• 基于现代技术栈：使用Ember.js框架和Semantic UI构建，提供响应式用户界面
• 多语言支持：通过Weblate支持多语言本地化
• 全面测试覆盖：包含验收测试、集成测试和单元测试，确保功能稳定性
• 灵活部署：支持本地部署、GitHub Pages、Docker等多种部署方式
• CI/CD集成：通过GitHub Actions实现持续集成，自动构建和测试
• 版本控制：遵循语义化版本（Semantic Versioning），定期发布稳定版本

使用场景和适用范围

• 活动组织者：创建、编辑和管理事件信息，包括日程、演讲者、票务等
• 事件参与者：浏览事件列表、查看事件详情、注册参与活动
• 开发团队：二次开发或集成到自定义事件管理系统中
• 企业/社区：搭建内部或公开的事件管理平台

使用方法和配置说明

Docker部署

镜像获取

Docker镜像托管在Docker Hub的eventyay组织下，支持以下标签：

基本运行命令

bash
docker run -d -p 4200:4200 eventyay/open-event-frontend:latest

访问 http://localhost:4200 即可使用应用。

环境变量配置

通过环境变量自定义配置，可通过-e参数传递：

bash
docker run -d -p 4200:4200 \
  -e API_URL=https://api.eventyay.com \
  eventyay/open-event-frontend:latest

主要环境变量说明：

• API_URL：后端API地址（默认：[***]
• NODE_ENV：运行环境（development/production，默认：production）

Docker Compose配置示例

yaml
version: '3'
services:
  open-event-frontend:
    image: eventyay/open-event-frontend:latest
    ports:
      - "4200:4200"
    environment:
      - API_URL=https://api.eventyay.com
    restart: always

本地开发

首次设置

bash
# 安装依赖
yarn
# 复制环境变量示例文件
cp .env.example .env
# 生成本地化文件
yarn l10n:generate

运行开发服务器

bash
yarn start
# 访问 http://localhost:4200

运行测试

bash
# CLI测试输出
yarn test
# 浏览器预览测试
yarn test --server

构建生产版本

bash
# 开发环境构建
yarn build
# 生产环境构建
yarn build -prod

部署信息

官方部署

• Master分支：部署于生产环境 [] [] 作为后端API
• Development分支：部署于 [] [] 作为后端API

版本发布周期

从1.0.0版本开始定期发布稳定版本，遵循语义化版本规范。

进一步阅读

• ember.js
• ember-cli
• Semantic UI
• https://semantic-org.github.io/Semantic-UI-Ember/
• 开发浏览器扩展：
  • Chrome Ember Inspector
  • Firefox Ember Inspector

贡献最佳实践

提交规范

• 编写清晰有意义的Git提交信息（参考如何编写Git提交信息）
• 使用GitHub关键词自动关联并关闭相关Issue（参考https://github.com/blog/1506-closing-issues-via-pull-requests%EF%BC%89
• 小修复需合并提交，避免过多零散提交（参考如何合并提交）
• UI相关PR建议附带截图或测试链接，便于审核

功能请求与Bug报告

提交Issue时需包含复现步骤，尤其是罕见或复杂Bug。

参与开发

• 先在本地搭建项目并熟悉应用功能
• 欲处理Issue时，可在Issue下留言申请分配

许可证

本项目采用Apache License 2.0许可。

如需其他许可方式，请联系FOSSASIA。