# smartunity

**Repository Path**: smartunity/smartunity

## Basic Information

- **Project Name**: smartunity
- **Description**: 开源轻量管理端框架：Spring Boot 3 + Vue 3，单机 jar 部署，可作行业信息化底座。Apache-2.0。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-28
- **Last Updated**: 2026-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SmartUnity

开源轻量级管理端框架，面向小型机构单机部署（`java -jar` + 浏览器）。提供完整的系统管理（用户、角色、菜单、部门、字典、参数、操作日志、文件上传）与 Vue 3 管理界面，可作为养老院信息化等**产品仓库**的基础底座。

- 源码托管：[Gitee](https://gitee.com/smartunity/smartunity)
- 许可证：[Apache License 2.0](LICENSE)

## 环境要求

| 工具 | 版本 |
|------|------|
| JDK | **17+** |
| Maven | **3.9+** |
| Node.js | **20+**（仅前端开发或完整 `package` 时需要） |

验证环境：

```bash
java -version
mvn -version
```

## 快速开始（从零跑起）

在**新机器**上克隆后，一条命令打出可运行 jar（含前端，首次会下载 Node 并执行 `npm install`，耗时数分钟）：

```bash
git clone https://gitee.com/smartunity/smartunity.git
cd smartunity
mvn clean package -pl smartunity-admin -am -DskipTests
java -jar smartunity-admin/target/smartunity-admin-1.0.0-SNAPSHOT.jar --spring.profiles.active=prod
```

1. 浏览器打开 http://localhost:8240  
2. 使用默认管理员登录（见下表）  
3. **首次登录须修改密码**；生产环境部署后请立即改密  

| 项 | 值 |
|----|-----|
| 用户名 | `admin` |
| 初始密码 | `123456` |

启动后在 jar **同级目录**生成：

- `./data/` — H2 数据库文件  
- `./uploads/` — 上传文件（`{bizType}/{yyyy}/{MM}/{dd}/{uuid}.{ext}`）

## 构建

```bash
# 全量编译 + 单元/集成测试（CI 常用，跳过前端以加速）
mvn clean verify -Dskip.frontend=true

# 全量 install（含测试，跳过前端）
mvn clean install -DskipTests -Dskip.frontend=true

# 生产单 jar（含 admin-ui 静态资源）
mvn clean package -pl smartunity-admin -am -DskipTests
```

仅打包后端、跳过前端：`mvn package -pl smartunity-admin -DskipTests -Dskip.frontend=true`

## 运行模式

### 生产（单 jar，推荐）

```bash
java -jar smartunity-admin/target/smartunity-admin-1.0.0-SNAPSHOT.jar --spring.profiles.active=prod
```

访问 http://localhost:8240（API 与页面同端口）。

### 开发（后端 + 前端热更新）

```bash
# 终端 1：后端
mvn -pl smartunity-admin spring-boot:run -Dspring-boot.run.profiles=dev

# 终端 2：前端（/api 代理到 8240）
cd admin-ui && npm install && npm run dev
```

- API：http://localhost:8240  
- 前端 dev：http://localhost:8241  

## 技术栈

- Java 17、Spring Boot 3.5.x、Spring Security 6、JWT  
- MyBatis-Plus、Flyway、H2（文件库）  
- Vue 3 + Vite + Element Plus（`admin-ui/`，打包进 jar 的 `classpath:/static/`）

## 模块说明

| 模块 | 说明 |
|------|------|
| `smartunity-dependencies` | BOM 版本管理 |
| `smartunity-common` | 公共类型、`BaseEntity`、工具 |
| `smartunity-security` | 安全与 JWT |
| `smartunity-system` | 系统管理领域 |
| `smartunity-file` | 文件上传 |
| `smartunity-admin` | 可运行应用（打包时嵌入 `admin-ui`） |
| `admin-ui` | Vue 3 管理端源码 |

## 产品方 / 二次开发

- [产品仓库接入指南](doc/产品仓库接入指南.md) — 如何依赖 BOM、新建行业仓库  
- [Gitee Packages 发布与 CI](doc/Gitee-Packages发布与CI.md) — `mvn deploy`、令牌、版本发布流程  

本地仅联调框架时，在根目录执行 `mvn install` 即可，无需发布私服。

## 文档

| 文档 | 说明 |
|------|------|
| [架构说明](doc/SmartUnity架构说明.md) | 模块、API、安全、建表约定 |
| [开发规划](doc/SmartUnity开发规划.md) | 分阶段实施与验收 |
| [代码规范](doc/SmartUnity代码规范.md) | 注释与风格 |
| [贡献指南](CONTRIBUTING.md) | 提交 PR 前检查项 |

## 已知限制

- 设计为**单实例**部署；多实例需自行解决会话、文件与数据库。  
- 默认 H2 文件库适合小型单机；大规模场景请替换为 MySQL/PostgreSQL 并调整配置。  
- `mvn deploy` 需在 `~/.m2/settings.xml` 配置 Gitee 令牌，见发布文档。

## 贡献

欢迎 Issue 与 Pull Request，请先阅读 [CONTRIBUTING.md](CONTRIBUTING.md)。

## 许可证

[Apache License 2.0](LICENSE)