a11ywatch/a11ywatch-core

a11ywatch-core

a11ywatch的核心API服务，作为系统中枢提供集中式接口支持，是a11ywatch功能实现与集成的核心组件，负责处理主要业务逻辑和数据交互。

核心功能与特性

• 提供a11ywatch系统的集中式API接口
• 支持用户角色权限管理（免费、基础、高级、企业版）
• 与MongoDB数据库集成，处理数据存储与查询
• 支持邮件功能，需配置密钥文件

使用场景与适用范围

适用于a11ywatch系统的开发、测试及生产环境部署，作为核心服务组件提供API支持，满足不同用户角色的功能需求。

使用方法与配置说明

Docker部署

通过docker-compose快速启动服务：

bash
docker-compose up

本地构建

1. 安装依赖：

   bash
   npm install
   

2. 启动开发模式：

   bash
   npm run dev
   

数据库配置

当前仅本地运行时需要以下配置：

1. 本地启动MongoDB服务，并设置环境变量DB_URL，示例：

   DB_URL=mongodb://127.0.0.1:27017/?compressors=zlib&gssapiServiceName=mongodb
   

2. 从团队成员获取mongodump数据，执行数据恢复：

   bash
   mongorestore
   

数据信息

用户角色

不同用户角色对应不同权限级别：

free: role = 0  # 免费用户
basic: role = 1  # 基础用户
premium: role = 2  # 高级用户
entreprise: role = 3  # 企业用户

模型设置

模型文件夹中的方法参数规则：

• 第一个参数为直接属性后代
• 第二个参数为查询参数

邮件功能配置

要启用邮件功能，需通过SSH或其他方式在项目根目录添加private.key和public.key密钥文件。

发布注意事项

使用Docker镜像进行生产构建时，需在子目录根目录添加服务器的私钥和公钥文件后再进行构建。

许可证

详见项目根目录下的LICENSE文件。