快速构建用户系统的利器：appy-backend

项目介绍

appy-backend 是 appy 项目的服务器部分，它提供了一个基于 rest-hapi API 生成器的用户系统模板。该项目受到 frame 用户系统的启发，旨在提供一个易于使用且功能强大的用户 API，能够支持广泛的应用场景。无论是构建新应用还是扩展现有应用，appy-backend 都是一个极佳的起点。

项目技术分析

appy-backend 基于 hapi 框架构建，其 RESTful API 端点通过 rest-hapi 生成。模型基于 mongoose，数据存储在 MongoDB 中。通过 rest-hapi，添加新端点只需定义新模型，模型关联也非常简单。

项目及技术应用场景

appy-backend 适用于几乎所有需要用户系统的应用场景，包括但不限于：

• 社交网络：用户注册、登录、权限管理等功能。
• 企业内部系统：员工管理、权限分配、数据访问控制等。
• 电商平台：用户账户管理、订单处理、支付系统等。
• 实时聊天应用：通过 @hapi/nes 实现 WebSocket 聊天功能。

项目特点

• 用户注册与激活：支持完整的用户注册和账户激活流程。
• 登录系统：包括忘记密码和重置密码功能。
• 社交登录：集成社交平台登录功能。
• 登录尝试检测：防止恶意登录尝试。
• 权限管理：基于角色和组的用户权限管理。
• 多种认证策略：提供三种可选的认证策略。
• WebSocket 聊天：通过 @hapi/nes 实现实时聊天功能。
• 文件上传 API：支持文件上传功能。
• 端点验证与查询支持：提供端点验证和查询支持。
• Swagger 文档：自动生成 Swagger 文档，方便端点访问和测试。

快速开始

安装与配置

使用 Docker

无需额外安装，只需复制 .env-docker-sample 到 .env-docker 并根据需要进行编辑。

不使用 Docker

$ npm install

复制 .env-sample 到 .env 并根据需要进行编辑。

首次设置

警告：这将清除 MongoDB 数据库中的所有数据。

如果需要种子数据，运行：

使用 Docker

$ sh seed_data.sh

不使用 Docker

$ npm run seed

运行 appy-backend

使用 Docker

$ sh run_server.sh

不使用 Docker

$ npm start

启动后，访问 http://localhost:8080/ 查看 Swagger 文档。

了解更多

更多详细信息，请访问 Wiki 页面，了解认证、授权、日志记录和端点测试等内容。

贡献与支持

如果您有任何问题、建议或功能请求，请随时在 GitHub 上提交问题。我们非常欢迎您的贡献！

感谢您选择 appy-backend，祝您开发愉快！