# smart-estate

**Repository Path**: gui-shuo/smart-estate

## Basic Information

- **Project Name**: smart-estate
- **Description**: 一个专注于智能社区管理的开源项目，提供全面的技术支持与解决方案，涵盖社区管理、交易流程自动化及数据分析等功能。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-28
- **Last Updated**: 2025-12-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SmartEstate - 智享社区智慧物业管理系统

## 📋 项目简介

SmartEstate（智享社区）是一款面向现代化住宅小区、园区的综合物业管理服务平台，通过数字化手段提升物业管理效率，优化业主居住体验。

## 🛠️ 技术栈

### 后端
- **Java 17+**
- **Spring Boot 3.1.5**
- **MyBatis-Plus 3.5.7**
- **MySQL 8.0**
- **Redis**
- **Spring Security + JWT**
- **Maven**

### 前端
- **Vue 3**
- **TypeScript**
- **Vite**
- **Element Plus**
- **Pinia**
- **Vue Router**

## 📁 项目结构

```
smart-estate/
├── smartestate-backend/          # 后端项目
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/
│   │   │   │   └── com/smartestate/backend/
│   │   │   │       ├── common/          # 通用类（Result、异常等）
│   │   │   │       ├── config/          # 配置类
│   │   │   │       │   └── security/    # Security配置
│   │   │   │       ├── controller/      # 控制器
│   │   │   │       ├── dto/             # 数据传输对象
│   │   │   │       ├── entity/          # 实体类
│   │   │   │       ├── mapper/          # MyBatis Mapper
│   │   │   │       ├── service/         # 业务逻辑
│   │   │   │       ├── utils/           # 工具类
│   │   │   │       └── vo/              # 视图对象
│   │   │   └── resources/
│   │   │       ├── application.yml      # 配置文件
│   │   │       ├── mapper/              # MyBatis XML
│   │   │       └── sql/                 # SQL脚本
│   │   │           ├── schema.sql       # 表结构
│   │   │           └── data.sql         # 初始化数据
│   │   └── test/
│   └── pom.xml
│
├── smartestate-frontend/         # 前端项目
│   ├── src/
│   │   ├── api/                  # API接口
│   │   ├── assets/               # 静态资源
│   │   ├── components/           # 公共组件
│   │   ├── layout/               # 布局组件
│   │   ├── router/               # 路由配置
│   │   ├── store/                # Pinia状态管理
│   │   ├── utils/                # 工具函数
│   │   ├── views/                # 页面组件
│   │   ├── App.vue
│   │   └── main.ts
│   ├── package.json
│   └── vite.config.ts
│
├── REQUIREMENTS.md               # 需求文档
└── README.md                     # 项目说明
```

## 🚀 快速开始

### 环境准备

1. **安装 JDK 17+**
2. **安装 Maven 3.6+**
3. **安装 MySQL 8.0+**
4. **安装 Redis**
5. **安装 Node.js 18+**

### 数据库初始化

```bash
# 1. 创建数据库并导入表结构
mysql -u root -p < smartestate-backend/src/main/resources/sql/schema.sql

# 2. 导入初始化数据
mysql -u root -p < smartestate-backend/src/main/resources/sql/data.sql
```

### 后端启动

```bash
cd smartestate-backend

# 修改 application.yml 中的数据库和Redis配置

# 启动项目
mvn spring-boot:run

# 或使用IDE运行 SmartEstateApplication.java
```

后端服务默认运行在: `http://localhost:8080/api`

### 前端启动

```bash
cd smartestate-frontend

# 安装依赖（如果未安装）
npm install

# 启动开发服务器
npm run dev
```

前端服务默认运行在: `http://localhost:5173`

## 👤 默认账号

| 用户名 | 密码 | 角色 |
|--------|------|------|
| admin | 123456 | 超级管理员 |
| manager | 123456 | 物业经理 |
| service01 | 123456 | 客服 |
| repair01 | 123456 | 维修工 |

## 📦 核心功能模块

### 1. 系统管理
- ✅ 用户管理：CRUD、角色分配
- ✅ 角色管理：RBAC权限模型
- ✅ 菜单管理：动态路由配置
- ✅ 部门管理：组织架构

### 2. 资产管理
- 楼栋管理：小区楼栋信息
- 房屋管理：房屋档案、状态管理

### 3. 住户管理
- 业主档案：业主/租户信息
- 入住管理：入住、迁出流程

### 4. 费用管理
- 费用配置：物业费、水电费规则
- 账单生成：自动生成月度账单
- 缴费管理：线上/线下缴费记录

### 5. 社区服务
- 报修管理：报修工单流程
- 公告通知：社区公告发布

## 🔐 API文档

### 认证接口

#### 登录
```
POST /api/auth/login
Content-Type: application/json

{
  "username": "admin",
  "password": "123456"
}

Response:
{
  "code": 200,
  "message": "登录成功",
  "data": {
    "token": "eyJhbGciOiJIUzUxMiJ9...",
    "userId": 1,
    "username": "admin",
    "realName": "超级管理员",
    "roles": ["ROLE_SUPER_ADMIN"],
    "permissions": ["system:user:list", ...]
  }
}
```

#### 获取当前用户信息
```
GET /api/auth/info
Authorization: Bearer {token}
```

## 📊 数据库设计

核心表：
- `sys_user` - 系统用户表
- `sys_role` - 角色表
- `sys_menu` - 菜单权限表
- `base_building` - 楼栋表
- `base_house` - 房屋表
- `base_owner` - 业主表
- `fee_config` - 费用配置表
- `fee_bill` - 账单表
- `srv_repair` - 报修工单表
- `srv_notice` - 公告表

## 🔧 配置说明

### 后端配置 (application.yml)

```yaml
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/smartestate
    username: root
    password: your_password
    
  data:
    redis:
      host: localhost
      port: 6379
      
jwt:
  secret: your_jwt_secret_key
  expiration: 604800000  # 7天
```

## 📝 开发规范

1. **代码规范**：遵循阿里巴巴Java开发手册
2. **提交规范**：使用语义化的commit message
3. **分支管理**：采用 Git Flow 工作流
4. **接口规范**：RESTful API 设计规范