# rabbit

**Repository Path**: kaiser-smith/rabbit

## Basic Information

- **Project Name**: rabbit
- **Description**: 大展鸿兔
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 2
- **Created**: 2025-11-03
- **Last Updated**: 2025-12-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Rabbit

#### 介绍
Rabbit（大展鸿兔），该项目提供完整的设备接入、数据采集、远程控制、数据分析以及兔子养殖相关流程。

#### 软件架构
项目采用前后端分离架构，包含以下核心模块：

**后端服务** (`fastbee-server`)
- 路径rabbit/fastbee/springboot
- 基于 Spring Boot 3.0 + JDK 17
- 数据库：MySQL 8.0 + Redis 7.0
- 消息队列：EMQ X Broker 5.0
- 协议支持：MQTT、TCP、HTTP、CoAP 等
- 主要功能：设备管理、数据采集、规则引擎、告警管理

**Web管理端** (`fastbee-admin`)
- 路径rabbit/fastbee/
- 基于 Vue3 + Element Plus
- 技术栈：TypeScript + Vite + Pinia
- 功能模块：设备监控、数据可视化、用户管理、系统配置

**移动端** (`fastbee-app`)
- 路径rabbit/fastbee-app
- 基于 UniApp 开发
- 支持 Android 和 iOS
- 功能：设备控制、实时数据、告警通知

**之前的前后端** (`iot-rabbit`)
- 路径rabbit/iot-rabbit
- 基于 鸿蒙、springboot、python 开发
- 功能：设备控制、实时数据、告警通知

#### 安装教程

**环境要求**
- JDK 17+
- MySQL 8.0+
- Redis 7.0+
- Maven 3.6+
- Node.js 16+

**后端部署**
详见：https://fastbee.cn/doc/install/system.html
1. 克隆项目
```bash
git clone https://gitee.com/kaiser-smith/rabbit.git
```

2. 修改配置文件（目前开发版本的所有数据均是服务器上面的，这样大家本地不用在进行下面的步骤）
```properties
# application.yml
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/fastbee
    username: your_username
    password: your_password
  redis:
    host: localhost
    port: 6379
```

4. 启动服务
- 基于IDEA打开项目文件rabbit/fastbee/springboot，待软件配置成功过后直接启动就行

**前端部署**
详见：https://fastbee.cn/doc/install/vue.html
1. 安装依赖
- 基于VSCode打开rabbit/fastbee/vue，该路径下执行一下操作之一
```bash
npm install
npm install --registry=https://registry.npmmirror.com
```

2. 配置接口地址
- 根目录的 .env.development是相关接口配置，我已经弄好，直接执行下一步即可

3. 构建项目
```bash
npm run dev
```
- 打开浏览器，输入：http://localhost:80 默认账户/密码 admin/admin123 。若能正确展示登录页面，并能成功登录，菜单及页面展示正常，则表明环境搭建成功。


**移动端部署**
详见：https://fastbee.cn/doc/install/mobile.html
1. 安装依赖
```bash
cd fastbee-app
npm install
```

2. 配置接口地址
```javascript
// config.js
export const BASE_URL = 'http://your-server-ip:8080'
```

3. 运行调试
```bash
# 微信小程序
npm run dev:mp-weixin

# H5
npm run dev:h5
```

#### 使用说明

1. **设备接入**
   - 支持MQTT、TCP、HTTP等多种协议接入
   - 提供设备SDK和接入文档
   - 支持一机一密认证方式

2. **数据监控**
   - 实时显示设备状态和数据
   - 支持数据图表展示
   - 提供历史数据查询

3. **告警管理**
   - 支持阈值告警设置
   - 多种告警通知方式（邮件、短信、站内信）
   - 告警级别管理

4. **规则引擎**
   - 可视化规则配置
   - 支持设备联动控制
   - 数据转发到第三方平台

#### 代码提交规范

为确保代码质量和团队协作有序，所有开发人员必须遵循以下代码提交规范。

##### 📋 分支结构说明

| 分支类型 | 命名规范 | 说明 | 保护 |
| :--- | :--- | :--- | :--- |
| **master** | `master` | **主分支**，用于生产环境，存放稳定代码。 | ✅ 受保护 |
| **负责人分支** | `dev-backend`<br>`dev-miniprogram`<br>`dev-harmony` | 各板块**集成分支**，由板块负责人维护。 | ✅ 受保护 |
| **个人开发分支** | `feat/板块/姓名-功能`<br>`fix/板块/姓名-问题` | 开发人员**个人分支**，基于对应的负责人分支创建。 | ❌ 不受保护 |

##### 🚀 开发流程

**1. 初始化：获取代码并创建个人分支**
```bash
# 克隆仓库
git clone https://gitee.com/kaiser-smith/rabbit.git
cd rabbit

# 获取最新代码（以对应板块为例）
git checkout dev-backend  # 后端板块
git checkout dev-miniprogram  # 小程序板块  
git checkout dev-harmony  # 鸿蒙板块
git pull origin 对应的负责人分支

# 基于负责人分支创建你的个人功能分支
git checkout -b feat/backend/zhangsan-user-auth  # 后端示例
git checkout -b feat/miniprogram/lisi-payment  # 小程序示例
git checkout -b feat/harmony/wangwu-device  # 鸿蒙示例
```

**2. 开发：在个人分支上提交代码**
```bash
# 进行开发工作...
# 添加更改
git add .

# 提交更改（请遵循提交信息规范）
git commit -m "feat: 实现用户登录认证功能"

# 推送到远程
git push -u origin 你的分支名
```

**3. 首次审核：向负责人分支提交Pull Request**
1. 在Gitee上，从你的个人分支向**对应的负责人分支**发起Pull Request
2. **标题格式**：`[板块] 类型: 简要描述`，例如：`[Backend] feat: 用户登录认证功能`
3. **描述内容**：清晰说明本次提交的改动内容、关联需求或问题
4. 在评审列表中**指定你的板块负责人**作为评审者
5. 板块负责人进行代码审查，通过后合并到负责人分支

**4. 最终审核：由负责人合并至master**
- 板块负责人定期将已测试的负责人分支向 `master` 分支发起Pull Request
- 和lsc确保各板块集成无误后合并

##### ✨ 分支命名规范

- **功能开发**：`feat/板块/姓名-功能描述`
  - `feat/backend/zhangsan-user-auth`（后端）
  - `feat/miniprogram/lisi-payment`（小程序）
  - `feat/harmony/wangwu-device`（鸿蒙）

- **Bug修复**：`fix/板块/姓名-问题描述`
  - `fix/backend/zhangsan-login-bug`

- **文档更新**：`docs/板块/姓名-文档内容`
  - `docs/backend/zhangsan-api-docs`

##### 📝 提交信息规范

提交信息格式：`<类型>: <描述>`

**常用类型**：
- `feat`: 新功能
- `fix`: 修复bug
- `docs`: 文档更新
- `style`: 代码格式调整
- `refactor`: 代码重构
- `test`: 测试相关
- `chore`: 构建过程或辅助工具变动

**例子**：
- `feat: 新增设备MQTT接入功能`
- `fix: 修复数据采集异常问题`
- `docs: 更新物联网协议文档`



##### ⚠️ 重要提醒

- **严禁**直接向 `master` 分支提交代码
- **严禁**在未通过PR审核的情况下合并代码
- 发起PR前，请确保分支已经过充分自测
- 保持个人分支与负责人分支的同步，避免冲突

如有任何关于代码提交的问题，请及时与你的板块负责人沟通。

#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  基于 FastBee 开源物联网平台构建
3.  支持多种物联网通信协议
4.  提供完整的前后端和移动端解决方案
5.  支持云端部署和私有化部署
6.  完善的设备管理和数据监控功能

#### 相关链接
- 官方文档：https://fastbee.cn/doc
- 演示地址：https://fastbee.cn

#### 许可证
Apache License 2.0