diff --git a/WebUI/README.md b/WebUI/README.md index 0b42ceebf00c40e18ffa51f943a9b1f97a786215..dd0b68d6ed0e2de8d1762748aec2fc36a9e9fad1 100644 --- a/WebUI/README.md +++ b/WebUI/README.md @@ -1,94 +1,72 @@ -
- -
-
-
-
-
-
-
-
-
-
-
- Live Preview - · - Documentation -
- -
-
-### Features
-
-- Various provided pages for develop
-- Complete directory structure for develop
-- Code specification configuration
-- Support dark mode
-- Custom theme colors
-- Various space layouts
-- Mock data scheme
-
-### Usage
-
-> Initialize project with our CLI tool `tdesign-starter-cli`
-
+# AnyLink 微链接系统
+
+## 项目简介
+AnyLink 是一个基于 .NET 8 的微服务链接管理系统,提供统一的链接管理、权限控制和系统监控功能。系统包含完整的用户权限体系、操作日志记录和配置管理模块。
+
+## 技术架构
+- 后端:.NET 8 + SqlSugar + JWT 认证
+- 前端:Vue3 + TypeScript + Vite
+- 数据库:支持多数据库配置
+- 缓存:内存缓存与分布式缓存支持
+- 功能模块:
+ - 用户权限管理(RBAC)
+ - 菜单权限控制
+ - 操作日志记录
+ - 系统参数配置
+ - 字典管理
+ - 部门/岗位管理
+
+## 核心功能
+- **用户认证**:JWT令牌认证,支持刷新令牌
+- **权限控制**:基于角色的菜单权限和数据权限控制
+- **系统配置**:动态参数配置管理
+- **操作审计**:完整记录所有操作日志
+- **数据字典**:统一管理系统字典数据
+- **部门管理**:支持多级部门结构
+- **岗位管理**:关联用户与岗位信息
+
+## 开发环境搭建
+1. 安装 .NET 8 SDK
+2. 配置数据库连接
+3. 安装前端依赖:`npm install`
+4. 启动后端:`dotnet run`
+5. 启动前端:`npm run dev`
+
+## 部署说明
+### 后端部署
+使用 Docker 部署:
```bash
-## install tdesign-starter-cli
-npm i tdesign-starter-cli@latest -g
-
-## create project
-td-starter init
+docker build -t anylink .
+docker run -d -p 8080:80 anylink
```
-### Develop
-
+### 前端部署
+构建生产环境:
```bash
-## install dependencies
-npm install
-
-## set up
-npm run dev
-```
-
-### Build
-
-```bash
-## build
npm run build
-
-## build for test
-npm run build:test
```
-
-### Contributing Guide
-
-We welcome contributions to our project. Create your [Issue](https://github.com/tencent/tdesign-vue-next-starter/issues/new/choose) or Submit your [Pull Request](https://github.com/Tencent/tdesign-vue-next-starter/pulls).
-
-#### Commit Specification
-
-- [Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
-- [Vue Style Guide](https://v3.vuejs.org/style-guide/#rule-categories)
-
-### Browser Support
-
-| [
](http://godban.github.io/browsers-support-badges/) IE / Edge | [
](http://godban.github.io/browsers-support-badges/)Firefox | [
](http://godban.github.io/browsers-support-badges/)Chrome | [
](http://godban.github.io/browsers-support-badges/)Safari |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 |
-
-### Community Versions
-
-There are kinds of community versions of starter-kit based on TDesign Vue Next, visit [community-link](https://tdesign.tencent.com/starter/docs/vue-next/community-link) for more detail. If you developed a community versions of tdesign starter, please create a issue or submit a pull request to let us know 😊.
-
-### License
-
-The MIT License. Please see [the license file](LICENSE) for more information.
+## API 文档
+### 认证接口
+- `/auth/login`:用户登录
+- `/auth/refresh`:刷新令牌
+
+### 系统接口
+- `/sys/config`:系统参数管理
+- `/sys/menu`:菜单权限管理
+- `/sys/user`:用户管理
+- `/sys/role`:角色管理
+- `/sys/dept`:部门管理
+- `/sys/post`:岗位管理
+- `/sys/dict`:字典管理
+- `/sys/log`:操作日志
+
+## 贡献指南
+欢迎提交 Pull Request,请遵循以下规范:
+1. Fork 项目
+2. 创建新分支
+3. 提交代码变更
+4. 创建 PR 描述变更内容
+
+## 开源协议
+本项目采用 MIT License 开源协议
\ No newline at end of file