eventyay/open-event-server

Open Event Server

!Open Event Server

![Build Status]([] ![CircleCI Build Staus Badge]([] ![Codacy Badge]([] ![Codecov branch]([] ![Gitter]([] ![Reviewed by Hound]([] ![Mailing List]([] ![ Follow]([***]

Open Event Server使组织者能够管理从音乐会到会议和聚会的各类活动。

它为具有多个轨道和场地的活动提供功能支持。活动管理者可以创建演讲者邀请表单，并通过拖放界面构建日程安排。活动信息存储在数据库中，系统提供API端点用于获取、修改和更新数据。组织者可以导入和导出标准压缩文件格式的活动数据，其中包括JSON格式的事件数据和图像、音频等二进制媒体文件。

Open Event Server公开了符合JSON:API规范的完善文档化REST API，外部服务（如Open Event应用生成器和前端）可通过该API访问和操作数据。

API文档

• 项目的每个安装实例都包含API文档（例如测试环境：[***]
• 托管版本的API文档位于仓库的gh-pages分支：[***]

通信渠道

• 请加入我们的邮件列表 讨论项目相关问题。

[***]

• 我们的聊天频道在Gitter

gitter.im/fossasia/open-event-server

演示版本

项目仓库会自动部署演示版本：

• 基于master分支部署 - open-event-api.herokuapp.com
• 基于development分支部署 - open-event-api-dev.herokuapp.com

安装部署

Open Event Server可轻松部署在多种平台上，以下是平台特定的详细安装说明。

注意： 如果进行本地安装，请确保使用以下操作系统之一：

• Debian系Linux发行版（如Ubuntu）
• MacOS

1. 通用安装说明
2. 本地安装
3. Vagrant安装
4. Google Compute Engine部署
5. Google Container Engine（Kubernetes）部署
6. AWS EC2部署
7. Digital Ocean部署
8. Docker部署
9. Heroku部署

也支持一键Heroku部署：

![Deploy]([***]

技术栈

请熟悉项目组件以便贡献代码。

核心组件

• 数据库 - PostgreSQL
• Web框架 - Flask
• 应用服务器 - https://github.com/unbit/uwsgi
• Web服务器 - NGINX

注意：目前open-event-server仅支持Python 3.8。

外部服务依赖

OAuth社交认证

通过OAuth获取***和Google账户信息，支持用户使用相应凭证登录：

1. Google - [***]
2. *** - [***]

***

公共活动页面集成*** feed。需从[***]

Instagram

可扩展功能以在活动服务中提供Instagram图片。需从[***]

Google Maps

用于获取位置信息（国家、城市、经纬度等）。需从[***]

媒体存储 - 本地/Amazon S3/Google Cloud

媒体文件（如音频、头像、徽标）可存储在本地、Amazon S3或Google Storage。

1. Amazon S3设置说明
2. Google Cloud设置说明

邮件服务 - SMTP/Sendgrid

服务器可通过SMTP或Sendgrid API发送邮件：

1. SMTP可在admin/settings直接配置
2. 获取Sendgrid API令牌

Heroku API

若应用部署在Heroku，使用Heroku API获取最新版本并显示相关信息。需从[***]

支付网关

支持票务销售的支付网关集成：

1. Stripe - 获取密钥
2. *** - 获取凭证

数据访问

导入与导出

导入

Open Event服务器支持多种格式的导入源：

• 包含JSON（匹配API结构）和二进制媒体文件的zip归档文件，详情见此处。
• Pentabarf XML格式（示例文件）。

导出

活动数据和会话可导出为多种格式：

• 包含JSON（匹配API结构）和二进制媒体文件的zip归档文件，详情见此处。
• Pentabarf XML格式（示例文件）。
• iCal格式（示例文件）。
• xCal格式（示例文件）。

角色

系统包含两类角色：

1. 系统角色：与Open Event组织和应用操作员相关。
2. 事件角色：与系统用户及其不同权限相关。

详情见此处。

开发

开发模式

要启用开发模式（开发Flask配置），设置APP_CONFIG环境变量为"config.DevelopmentConfig"：

export APP_CONFIG=config.DevelopmentConfig

模型更新与迁移

修改模型后需使用迁移工具：

bash
# 生成模型更新后的迁移文件
python3 manage.py db migrate

# 同步数据库
python3 manage.py db upgrade

# 回滚迁移
python3 manage.py db downgrade

提交模型代码时，请同时更新迁移文件。

API文档

API使用api blueprint文档化。首先使用以下命令生成描述/蓝图.apib文件：

bash
npx aglio --input docs/api/api_blueprint_source.apib --compile --output docs/api/api_blueprint.apib # 生成描述.apib文件

可使用apiary gem查看本地文档更改：

bash
gem install apiaryio # 安装依赖
apiary preview --path docs/api/api_blueprint.apib # 在浏览器中预览生成的文档

测试

克隆仓库并按步骤设置服务器。确保已安装Poetry及测试所需依赖：

bash
# 安装Poetry
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
source ~/.profile

# 安装Python依赖
poetry install

# 激活项目虚拟环境
poetry shell

运行单元测试

• 若已安装docker并希望快速运行测试：

shell
./scripts/test_db.sh

在.env中设置TEST_DATABASE：

shell
TEST_DATABASE_URL=postgresql://test@localhost:5433/test

• 然后进入项目目录运行：

bash
pytest tests/

运行Robot框架测试

• 确保已安装FireFox
• 启动本地Flask服务器实例
• 进入项目目录运行测试：

bash
robot -v SERVER:{server_name} -v SUPERUSER_USERNAME:{super_user_email_here} -v SUPERUSER_PASSWORD:{super_user_password} tests/robot

替换{}中的参数，例如：

bash
robot -v SERVER:localhost:5000 -v SUPERUSER_USERNAME:test@opev.net -v SUPERUSER_PASSWORD:test_password tests/robot

• 测试完成后，根目录会生成report.html和log.html报告。

日志

系统记录特定信息并存储在数据库中，用于问题排查、安全审计和系统监控。详情见日志说明。

国际化（i18n）

![翻译状态]([***]

Open Event使用Weblate进行翻译，这是一个便于开发者和翻译者协作的Web工具。

若要参与翻译，请在该服务器注册，激活账户后前往翻译页面。

贡献、bug报告、功能请求

这是开源项目，欢迎提交bug报告、功能请求和拉取请求。请在此提交问题：https://github.com/fossasia/open-event-server/issues%E3%80%82%E5%BB%BA%E8%AE%AE%E5%85%88%E9%98%85%E8%AF%BBhttps://github.com/fossasia/open-event/tree/master/docs/dev-handbook%E4%BB%A5%E4%BA%86%E8%A7%A3%E5%9F%BA%E6%9C%AC%E7%94%9F%E6%80%81%E3%80%82

分支策略

我们有以下分支：

• development 所有开发工作在此分支进行。贡献时请向_development_提交拉取请求。所有PR必须通过Travis的构建检查和单元测试（[***] - 基于development分支部署，托管于Heroku）。

• master 包含已发布代码。当development分支积累足够的功能/修复后，进行版本更新并发布（[***] - 基于master分支部署，托管于Google Cloud Platform（Google Container Engine + Kubernetes））。

• gh-pages 包含文档网站[***]

发布策略

目前（由于活跃开发和较多bug）的暂定发布策略为每周一和周五发布alpha版本。因此，bug修复需等到master分支发布新版本后才会反映在eventyay.com上。

贡献最佳实践

提交

• 编写清晰有意义的git提交信息（参考[***]
• PR描述中使用GitHub特殊关键字引用，以便合并时自动关闭相关issue（详情：https://github.com/blog/1506-closing-issues-via-pull-requests%EF%BC%89
• 对PR进行微小修改（如修复Travis构建失败、样式调整或 reviewers要求的小改动）后，请压缩提交，避免过多提交记录（学习压缩方法：[***]
• 提交UI相关PR时，添加更改截图或部署链接，便于reviewers快速评估。

功能请求和bug报告

• 提交功能请求或bug报告时，确保包含复现步骤，尤其是罕见bug。

参与开发

• 开始开发前，请在本地搭建系统并全面测试应用，探索所有链接和按钮，熟悉功能布局。
• 在本地测试应用并探索管理区域（Heroku测试部署不提供管理权限，管理区域可开关模块如票务系统、添加服务密钥如S3存储）。
• 若要处理某个issue，请在issue下评论。若issue已分配但无进展，可留言请求分配。

许可证

本项目目前采用GNU General Public License v3 许可证。

如需获取不同许可证下的软件，请联系FOSSASIA。