From a3b9279c199b455f7a356194dbcd4e29c00882f2 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Wed, 16 Jul 2025 03:38:53 +0000 Subject: [PATCH] Update README.md --- README.md | 142 +++++++++++++++--------------------------------------- 1 file changed, 38 insertions(+), 104 deletions(-) diff --git a/README.md b/README.md index 50ee186..9f86712 100644 --- a/README.md +++ b/README.md @@ -1,90 +1,42 @@ # IC Framework Service -一个基于 [Ic Framework](https://github.com/conesat/ic-framework)的服务框架,提供完整的前后端解决方案,包括system模块提供了权限校验、岗位部门等模块基础模块。 - -在线文档 [http://icframework.chinahg.top](http://icframework.chinahg.top) - -hotel是作者另外提供了酒店管理模块,包括酒店、房间、设施、房态等模块。 - -> 预览地址:[http://hotel.chinahg.top/](http://hotel.chinahg.top/) -> 账号 test 密码 Aa23456 - ## 📋 项目概述 +IC Framework Service 是一个多功能管理系统,支持多端访问(Web、移动端)。它提供了系统管理、项目管理、酒店管理等功能模块,并支持响应式设计,适用于不同平台的应用。 -IC Framework Service 是一个现代化的企业级应用开发框架,采用微服务架构设计,提供了完整的前后端分离解决方案。项目包含多个业务模块和多端应用支持。 - -### 🏗️ 项目架构 - -``` -ic-framework-service/ -├── ic-framework-system/ # 系统核心模块 -├── ic-framework-project/ # 项目模块 -├── ic-framework-hotel/ # 酒店管理模块 -├── app/ # Flutter 移动端应用 -├── _web/ # Web 前端应用 -│ ├── admin/ # 管理后台 (Vue 3 + TDesign) -│ └── uni/ # UniApp 跨平台应用 -└── doc/ # 项目文档 - -``` +## 🏗️ 项目架构 +项目采用模块化设计,包含多个功能模块,如系统管理、项目管理、酒店管理等。每个模块都具有独立的功能和API接口,便于维护和扩展。 ## 🚀 技术栈 ### 后端技术栈 -- **Java 21** - 最新 LTS 版本 -- **Spring Boot 3.x** - 微服务框架 -- **MyBatis** - 数据持久层框架 -- **MySQL** - 关系型数据库 -- **Redis** - 缓存和会话存储 -- **Caffeine** - 本地缓存 -- **Lettuce** - Redis 客户端 -- **Maven** - 项目构建工具 -- **Docker** - 容器化部署 +- **Java 21** +- **Spring Boot** +- **MyBatis Plus** +- **MySQL 8.0+** +- **Redis 6.0+** +- **Docker** (可选,用于容器化部署) ### 前端技术栈 -- **Vue 3** + **TypeScript** - 管理后台 -- **TDesign Vue Next** - UI 组件库 -- **Vite** - 构建工具 -- **Pinia** - 状态管理 -- **Vue Router** - 路由管理 -- **Axios** - HTTP 客户端 +- **Vue 3** +- **Vite** +- **Pinia** +- **TypeScript** +- **TDesign** ### 移动端技术栈 -- **Flutter** - 跨平台移动应用开发 -- **Dart** - 编程语言 -- **UniApp** - 跨平台小程序开发 +- **Flutter** +- **UniApp** ## 📦 模块说明 ### ic-framework-system -系统核心模块,提供基础功能: -- 用户认证与授权 -- 组织架构管理(部门、职位) -- 用户管理 -- 菜单权限管理 -- 系统设置 -- 字典管理 -- 文件上传(阿里云 OSS) -- 在线用户管理 +提供系统级别的功能,如用户管理、权限控制、菜单管理等。 ### ic-framework-project -最基本的项目模块,业务代码可以在这里完善 +提供项目管理功能,包括项目创建、任务管理、进度跟踪等。 ### ic-framework-hotel -酒店管理模块,提供酒店业务功能: -- 酒店信息管理 -- 房间管理 -- 楼栋管理 -- 配套设施管理 -- 房态管理 -- 酒店用户管理 - -### Web 前端应用 -- **admin**: 基于 Vue 3 + TDesign 的管理后台 -- **uni**: 基于 UniApp 的跨平台应用 - -### 移动端应用 -- **app**: 基于 Flutter 的原生移动应用 +提供酒店管理功能,包括酒店信息、房间管理、房态监控、配套设施等。 ## 🛠️ 开发环境要求 @@ -93,24 +45,25 @@ ic-framework-service/ - **Maven 3.6+** - **MySQL 8.0+** - **Redis 6.0+** -- **Docker** (可选,用于容器化部署) +- **Docker** (可选) ### 前端环境 -- **Node.js 18.0+** -- **pnpm** (推荐) 或 **npm** +- **Node.js 18+** +- **npm / pnpm** +- **Vue 3** +- **Vite** +- **Pinia** +- **TypeScript** ### 移动端环境 -- **Flutter SDK 3.3.3+** -- **Dart SDK** -- **Android Studio** (Android 开发) -- **Xcode** (iOS 开发,仅 macOS) +- **Flutter SDK** +- **HBuilderX** (用于UniApp开发) ## 🚀 快速开始 ### 1. 克隆项目 ```bash -git clone -cd ic-framework-service +git clone https://gitee.com/ic-framework/ic-framework-service.git ``` ### 2. 后端启动 @@ -137,7 +90,7 @@ mvn spring-boot:run ### 3. 前端启动 -#### 管理后台 +#### 箣理后台 ```bash cd _web/admin pnpm install @@ -162,8 +115,6 @@ flutter run ## 🐳 Docker 部署 -项目支持 Docker 容器化部署: - ### 构建镜像 ```bash # 构建项目模块 @@ -208,18 +159,12 @@ spring: ``` ### 文件上传配置 -支持阿里云 OSS 文件上传,需要配置相关参数。 +支持本地存储和OSS对象存储,可在配置文件中进行设置。 ## 🔧 开发指南 ### 代码生成 -项目集成了代码生成功能,可以快速生成 CRUD 代码: -- 实体类 -- Mapper 接口 -- Service 层 -- Controller 层 -- 前端页面 - +项目使用 MyBatis Plus 提供的代码生成工具,可快速生成实体类、Mapper、Service、Controller 等代码。 ### 权限控制 使用基于角色的权限控制(RBAC): @@ -253,30 +198,19 @@ spring: - ✅ 用户管理 ### 多端支持 -- ✅ Web 管理后台 +- ✅ Web 箾理后台 - ✅ 移动端 App - ✅ 小程序支持 - ✅ 响应式设计 ## 🤝 贡献指南 - 1. Fork 本仓库 -2. 创建特性分支 (`git checkout -b feature/AmazingFeature`) -3. 提交更改 (`git commit -m 'Add some AmazingFeature'`) -4. 推送到分支 (`git push origin feature/AmazingFeature`) -5. 打开 Pull Request +2. 创建 feature 分支 +3. 提交 Pull Request +4. 遵循提交规范(Commit规范、代码规范) ## 📄 许可证 - -本项目采用 [MIT License](LICENSE) 许可证。 +本项目遵循 MIT 开源协议。 ## 📞 联系我们 - -如有问题或建议,请通过以下方式联系: -- 提交 Issue -- 发送邮件至: [1092501244@qq.com] -- 项目主页: [https://github.com/conesat/ic-framework-service] - ---- - -⭐ 如果这个项目对您有帮助,请给我们一个 Star! \ No newline at end of file +如需技术支持或合作,请联系项目维护团队。 \ No newline at end of file -- Gitee