Parcourir la source

📊 添加文档

快乐的梦鱼 il y a 1 semaine
Parent
commit
d9d6e00ea0
1 fichiers modifiés avec 87 ajouts et 0 suppressions
  1. 87 0
      README.md

+ 87 - 0
README.md

@@ -0,0 +1,87 @@
+# 闽南文化小程序
+
+构建"数字闽南文化生态圈",打造集文化保护、学术研究、公众教育、产业应用于一体的综合性数字平台。通过建立"1+3+N"服务体系(1个核心数据库、3大应用终端、N个特色场景),形成覆盖全市的文化数字服务网络。
+
+本项目为闽南文化生态保护区(厦门市)的小程序项目源代码。
+
+## 技术栈
+
+### 前端核心技术
+
+- **框架**: Uniapp+Vue 3
+- **状态管理**: Pinia 3.0
+- **语言**: TypeScript
+- **样式预处理器**: Sass
+
+## 项目结构
+
+### 核心依赖
+
+- `pinia`: 状态管理库
+- `naeasy-ui-uniapp`: [NaEasy UI 组件库](./src/components/README.md)
+- `async-validator`: 表单验证
+- `sp-editor`: 富文本编辑器
+- `@imengyu/js-request-transform`: API请求转换工具
+
+### 目录组织
+
+```
+src/
+├── api/             # API请求模块
+│   ├── auth/        # 登录相关API
+│   ├── fusion/      # 文旅融合内容API
+│   ├── inheritor/   # 文化传承相关API
+│   ├── inhert/      # 村落相关API
+│   ├── introduction/# 闽南文化简介相关API
+│   ├── news/        # 资讯相关API
+│   ├── running/     # 文物跑相关API
+│   ├── user/        # 用户相关API
+│   ├── BaseAppServerRequestModule.ts  # 基础请求配置模块
+│   ├── RequestModules.ts             # 请求核心模块
+├── common/          # 通用功能
+│   ├── components/  # 通用组件
+│   ├── composeabe/  # 组合式函数
+│   ├── config/      # 配置文件
+│   ├── scss/        # 全局样式定义
+├── components/      # NaEasy UI 组件库
+├── pages/           # 页面
+│   ├── article/     # 文章相关页面
+│   ├── home/        # 首页相关页面
+│   ├── inhert/      # 传承相关页面
+│   ├── introduction/ # 闽南文化简介相关页面
+│   ├── parts/       # 页面模块组件拆分
+│   ├── travel/      # 文旅融合相关页面
+│   ├── user/        # 用户相关页面,登录,个人信息,投稿
+│   ├── video/       # 视频相关页面
+├── store/           # 状态管理模块
+│   ├── auth/        # 登录状态管理
+├── App.vue          # 应用入口
+├── main.ts          # 主入口文件
+├── manifest.json    # 应用配置
+├── pages.json       # 页面配置
+```
+
+## 开发与构建
+
+### 开发命令
+
+```bash
+# 启动H5开发服务器
+npm run dev:h5
+# 启动微信小程序开发服务器
+npm run dev:mp-weixin
+```
+
+### 构建命令
+
+```bash
+# 构建微信小程序版本
+npm run build:mp-weixin
+```
+
+### 类型检查
+
+```bash
+# 执行TypeScript类型检查
+npm run type-check
+```