From 28dd72da25c45e0598594156dc0ee0931ed9005a Mon Sep 17 00:00:00 2001 From: zyh Date: Wed, 9 Apr 2025 14:04:20 +0000 Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=20README.md=20=E6=96=87?= =?UTF-8?q?=E4=BB=B6=EF=BC=8C=E6=8F=90=E4=BE=9B=E9=A1=B9=E7=9B=AE=E6=A6=82?= =?UTF-8?q?=E8=BF=B0=E3=80=81=E6=8A=80=E6=9C=AF=E6=A0=88=E3=80=81=E5=8A=9F?= =?UTF-8?q?=E8=83=BD=E6=A8=A1=E5=9D=97=E3=80=81=E5=BF=AB=E9=80=9F=E5=BC=80?= =?UTF-8?q?=E5=A7=8B=E6=8C=87=E5=8D=97=E5=8F=8A=E9=85=8D=E7=BD=AE=E8=AF=B4?= =?UTF-8?q?=E6=98=8E=EF=BC=8C=E5=B8=AE=E5=8A=A9=E7=94=A8=E6=88=B7=E5=BF=AB?= =?UTF-8?q?=E9=80=9F=E4=BA=86=E8=A7=A3=E5=92=8C=E5=90=AF=E5=8A=A8=E7=AE=A1?= =?UTF-8?q?=E7=90=86=E7=AB=AF=E4=B8=8E=E7=A7=BB=E5=8A=A8=E7=AB=AF=E5=BA=94?= =?UTF-8?q?=E7=94=A8=E6=A8=A1=E6=9D=BF=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 106 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 106 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..530db98 --- /dev/null +++ b/README.md @@ -0,0 +1,106 @@ +# 管理端与移动端启动模板 (Admin-Mobile Starter) + +## 项目概述 + +这是一个基于 Deno 和 Hono 框架开发的管理系统与移动端应用启动模板，提供了完整的用户认证、权限管理、系统设置、文件上传、地图组件、图表组件等功能，可以快速构建企业级应用。 + +## 技术栈 + +- **后端框架**：Deno + Hono +- **前端框架**：React 19 + Ant Design 5 +- **状态管理**：TanStack Query +- **认证系统**：@d8d-appcontainer/auth +- **API客户端**：@d8d-appcontainer/api +- **地图组件**：高德地图（支持在线/离线模式） +- **图表组件**：Ant Design Charts +- **日期处理**：Day.js +- **网络请求**：Axios + +## 目录结构 + +- `asset/` - 前端资源文件 + - `admin/` - 管理端资源 + - `mobile/` - 移动端资源 + - `share/` - 共享资源和类型定义 +- `routes_*.ts` - 各模块路由定义文件 +- `app.tsx` - 应用主入口 +- `migrations.ts` - 数据库迁移 +- `deno.json` - Deno配置文件 + +## 功能模块 + +- **用户认证与管理** - 登录、注册、用户信息管理 +- **系统设置** - 站点信息、主题配置、全局参数设置 +- **文件管理** - 文件上传、分类管理 +- **地图组件** - 在线/离线地图、位置标记、地图交互 +- **图表组件** - 数据可视化图表 +- **移动端适配** - 响应式设计，支持移动端访问 + +## 快速开始 + +### 环境要求 + +- Deno 2.2.8 或更高版本 +- 数据库（由 @d8d-appcontainer/api 支持的数据库） + +### 环境变量配置 + +在启动应用前，可配置以下环境变量： + +``` +# 应用配置 +APP_NAME=应用名称 +ENV=development +JWT_SECRET=your-jwt-secret-key + +# OSS配置 +OSS_TYPE=aliyun # 可选值: aliyun, minio +OSS_BASE_URL=https://your-oss-url.com + +# 地图配置 +MAP_MODE=online # 可选值: online, offline +AMAP_KEY=您的地图API密钥 +``` + +### 启动应用 + +```bash +# 开发模式启动 +deno run -A app.tsx + +# 或使用配置文件启动 +deno run -A --config=deno.json app.tsx +``` + +## 配置说明 + +系统配置可通过环境变量或数据库中的系统设置进行管理，支持以下配置项： + +- 站点名称、图标、Logo +- 主题设置（明/暗模式） +- 地图模式（在线/离线） +- 图表主题 +- API 基础路径 +- 文件存储方式 + +## 数据库迁移 + +系统首次启动时会自动执行数据库迁移，创建必要的表结构和初始数据。 + +## 自定义开发 + +### 添加新路由 + +在 `routes_*.ts` 文件中定义新的路由处理函数，然后在 `app.tsx` 中引入并注册。 + +### 前端开发 + +前端资源位于 `asset/` 目录下，区分为管理端和移动端，可根据需要进行修改和扩展。 + +## 许可证 + +[License] - 请参阅LICENSE文件了解详情 + +--- + +© 2023 D8D. 保留所有权利。 \ No newline at end of file