🦫 Beaver Open - 海狸开放平台

🚀 海狸 IM 开放平台门户 - 基于 Vue 3 + Element Plus + TypeScript 构建，为第三方开发者提供应用管理、API 接入与 Webhook 配置

当前版本：2.0.2（以仓库根目录 VERSION 文件为准，与 package.json 同步）

English | 中文

---

✨ 核心特性

• 🧩 应用管理 - 创建应用、管理 AppID / AppSecret、应用状态控制
• 📊 数据统计 - API 调用与 Webhook 推送统计
• 🔔 Webhook 管理 - 事件订阅与推送日志查看
• 📖 API 文档 - 开放平台接口说明
• 📦 SDK 下载 - 多语言 SDK 获取入口
• 🎨 现代化 UI - 面向开发者的开放平台门户体验

🛠️ 技术栈

技术	版本	说明
Vue.js	3.5+	渐进式前端框架
TypeScript	5.8+	类型安全
Element Plus	2.10+	Vue 3 组件库
Vite	7.0+	下一代前端构建工具
Pinia	3.0+	Vue 状态管理
Vue Router	4.5+	官方路由管理器
Axios	1.10+	HTTP 客户端

🚀 快速开始

环境要求

• Node.js >= 18.0.0

安装步骤

# 克隆项目
git clone https://github.com/wsrh8888/beaver-open.git
cd beaver-open

# 安装依赖
npm install

# 启动开发服务器
npm run dev

# 构建生产版本
npm run build_prod

# 测试环境构建
npm run build_test

环境配置

1. 创建 .env.development 文件（开发环境）
2. 创建 .env.test 文件（测试环境）
3. 创建 .env.production 文件（生产环境）

🔗 相关项目

项目	仓库地址	说明
beaver-server	GitHub | Gitee	后端微服务
beaver-flutter	GitHub | Gitee	移动端（Flutter，推荐）
beaver-desktop	GitHub | Gitee	桌面端（Electron）
beaver-manager	GitHub | Gitee	后台管理系统
beaver-open	GitHub | Gitee	开放平台（本仓库）
beaver-oauth	GitHub | Gitee	OAuth 授权登录

📚 文档与帮助

• 📖 详细文档: Beaver IM 文档
• 🎥 视频教程: B站教程
• 💬 QQ群:
  • 1013328597 - 群一
  • 1044762885 - 群二
  • 1003121259 - 群三

🤝 贡献指南

我们欢迎所有形式的贡献！

1. Fork 本仓库
2. 创建特性分支 (git checkout -b feature/AmazingFeature)
3. 提交更改 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 开启 Pull Request

⭐ 支持项目

如果这个项目对你有帮助，请给我们一个 ⭐ Star！

📄 开源协议与免责声明

本项目基于 MIT 协议开源 - 详情请参阅 LICENSE 文件。

⚖️ 使用说明

项目定位：本项目主要用于技术学习和交流，希望为开发者提供一个学习和研究的平台。

使用建议：

• 📚 学习交流 - 欢迎用于个人学习、技术研究、学术交流
• 🤝 开源贡献 - 欢迎提交代码改进、Bug修复、功能建议
• 🔒 合规使用 - 请确保使用方式符合当地法律法规
• 💡 创新应用 - 鼓励基于本项目进行创新性应用开发

温馨提示：

• 本项目采用 MIT 开源协议，您可以自由使用、修改和分发
• 建议在使用前仔细阅读相关法律法规，确保合规使用
• 如有疑问或需要帮助，欢迎通过 QQ 群或 GitHub Issues 交流

📋 项目来源标注要求

重要：如果您基于本项目进行二次开发或发布，必须在项目中保留以下信息：

🖥️ 前端项目（移动端/桌面端/Web应用）

• 关于页面：必须在"关于我们"、"关于应用"或类似页面中包含项目来源标注
• 必需文本："基于 Beaver IM 开源IM项目开发"
• 链接：必须提供可点击的原始项目链接

🔧 后端项目（服务器/API服务）

• README.md：必须在项目介绍或描述中包含来源标注
• 必需文本："基于 Beaver IM 开源IM项目开发"
• 链接：必须提供可点击的原始项目链接

📄 通用要求

• LICENSE 文件：保留原项目 MIT 协议信息

💡 友好提醒：本项目允许个人及商业使用；基于本项目二次开发或发布时，必须保留项目来源标注，详见上方要求。

📖 详细法律条款：请参阅 LEGAL.md 文件了解完整的法律免责声明和使用要求。

⭐ Star历史

---

Made with ❤️ by Beaver IM Team
企业级即时通讯平台开放平台