Quellcode durchsuchen

📊 添加文档

快乐的梦鱼 vor 1 Woche
Ursprung
Commit
f8ca2b6c02
1 geänderte Dateien mit 88 neuen und 15 gelöschten Zeilen
  1. 88 15
      README.md

+ 88 - 15
README.md

@@ -1,33 +1,106 @@
-# mingnan-website
+# 闽南文化生态保护区(厦门市) 官网
 
-This template should help get you started developing with Vue 3 in Vite.
+构建"数字闽南文化生态圈",打造集文化保护、学术研究、公众教育、产业应用于一体的综合性数字平台。通过建立"1+3+N"服务体系(1个核心数据库、3大应用终端、N个特色场景),形成覆盖全市的文化数字服务网络。
 
-## Recommended IDE Setup
+本项目为闽南文化生态保护区(厦门市)的官网项目源代码。
 
-[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
+## 技术栈
 
-## Type Support for `.vue` Imports in TS
+### 前端核心技术
 
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
+- **框架**:Vue 3 + Nuxt 3(服务端渲染)
+- **状态管理**:Pinia
+- **UI 库**:Ant Design Vue 4.x
+- **路由**:Vue Router 4.x
+- **HTTP 客户端**:Axios
+- **样式**:Sass + Bootstrap 5
+- **地图**:高德地图 (@vuemap/vue-amap)
+- **开发语言**:TypeScript
+- **构建工具**:Vite + Webpack
 
-## Customize configuration
+### 核心依赖
 
-See [Vite Configuration Reference](https://vite.dev/config/).
+| 依赖 | 版本 | 用途 |
+|------|------|------|
+| vue | ^3.5.13 | 核心前端框架 |
+| nuxt | ^3.17.6 | 服务端渲染框架 |
+| pinia | ^3.0.1 | 状态管理库 |
+| ant-design-vue | ^4.2.6 | UI 组件库 |
+| axios | ^1.9.0 | HTTP 客户端 |
+| bootstrap | ^5.3.0 | 响应式布局框架 |
+| @vuemap/vue-amap | ^2.1.12 | 高德地图组件 |
+| typescript | ~5.8.0 | 类型系统 |
+| vite | ^6.2.4 | 现代构建工具 |
 
-## Project Setup
+## 项目结构
 
-```sh
-npm install
+### 目录组织
+
+```
+e:\Work\minnan-website/
+├── api/             # API 相关代码(按功能模块分类)
+├── assets/          # 静态资源
+│   ├── fonts/       # 字体文件
+│   ├── images/      # 图片资源
+│   └── scss/        # 样式文件
+├── common/          # 通用配置和工具
+│   └── config/      # 配置文件
+├── components/      # Vue 组件
+│   ├── content/     # 内容相关组件
+│   ├── controls/    # 控制组件
+│   ├── display/     # 显示组件
+│   ├── dynamicf/    # 动态表单组件
+│   ├── error/       # 错误处理组件
+│   ├── icons/       # 图标组件
+│   └── parts/       # 页面部分组件
+├── composeable/     # Vue 3 组合式 API 工具
+├── pages/           # 页面组件(按功能模块分类)
+├── public/          # 公共静态资源
+├── scripts/         # 脚本文件
+│   ├── ExportToAi/  # AI 导出相关脚本
+│   └── UpdateScript/ # 更新脚本
+├── server/          # 服务端相关代码
+├── stores/          # Pinia 状态管理
+├── App.vue          # 根组件
+├── nuxt.config.ts   # Nuxt 配置文件
+├── package.json     # 项目依赖配置
+└── tsconfig.json    # TypeScript 配置文件
 ```
 
-### Compile and Hot-Reload for Development
+### 功能模块
+
+- **introduction/**:闽南文化简介
+- **inheritor/**:非遗相关
+- **research/**文化研究
+- **news/**:新闻资讯
+- **communicate/**:文化交流
+- **fusion/**:文旅融合
+- **village/**:传统村落
+- **about/**:关于我们
+
+## 开发与构建
 
-```sh
+### 开发命令
+
+```bash
+# 启动开发服务器
 npm run dev
 ```
 
-### Type-Check, Compile and Minify for Production
+### 构建命令
 
-```sh
+```bash
+# 构建项目
 npm run build
+# 构建项目,并且自动发布更新至线上
+npm run updater ---- update post web
+# 构建 ICH 相关内容
+npm run build:ich
 ```
+
+### 类型检查
+
+```bash
+# 执行TypeScript类型检查
+npx vue-tsc
+```