DOCUMENTS_GUIDE.md

项目文档阅读指南

本文档帮助你快速了解项目中各个Markdown文档的内容和用途，方便你根据需要查阅相应文档。

文档列表

根目录文档

文档	内容概述	适用场景
README.md	项目基础概述：功能特点、技术栈、项目结构、快速启动命令、API接口列表	第一次了解项目、快速启动开发
PROJECT_DOCUMENTATION.md	完整项目文档：详细功能说明、前端页面更新说明、图标资源、生产部署Nginx配置示例	全面了解项目细节、部署配置参考
LOCAL_DEVELOPMENT_GUIDE.md	本地开发环境配置指南：MongoDB Docker启动、前后端环境变量配置、开发流程	在本地搭建开发环境
SERVER_MANAGEMENT_GUIDE.md	服务器运维指南：服务器信息、SSH连接、软件栈(Nginx/MongoDB/PM2)、服务状态检查、数据库管理、故障排查	服务器运维、问题排查
ADMIN_DASHBOARD.md	管理后台使用指南：功能说明、设置管理员、扩展统计项	管理员使用后台、新增统计数据

前端目录文档 (frontend/)

文档	内容概述	适用场景
README.md	前端项目说明：架构(Vite+React)、使用流程、环境变量配置、项目结构、API服务层、常见问题FAQ	前端开发入门、解决常见问题
SWITCH_ENVIRONMENT.md	环境切换方法：如何修改config.js切换开发/生产环境、环境配置详情	需要切换开发/生产API地址

小程序目录文档 (miniprogram/)

文档	内容概述	适用场景
README.md	小程序项目说明：功能介绍、运行方式、页面结构、登录方式、后端API配置、腾讯地图配置	小程序开发入门

---

按需求查阅文档

我想快速启动项目开发

→ 阅读 README.md 的「快速开始」部分

我想全面了解项目的所有功能和技术细节

→ 阅读 PROJECT_DOCUMENTATION.md

我想在本地搭建完整的开发环境

→ 阅读 LOCAL_DEVELOPMENT_GUIDE.md

我需要管理服务器或排查服务器问题

→ 阅读 SERVER_MANAGEMENT_GUIDE.md

我要进行前端开发

→ 先读 frontend/README.md，遇到环境切换问题看 frontend/SWITCH_ENVIRONMENT.md

我要进行小程序开发

→ 阅读 miniprogram/README.md

我要部署项目到生产服务器

→ 阅读 PROJECT_DOCUMENTATION.md 的「生产部署」部分 + SERVER_MANAGEMENT_GUIDE.md

我要使用管理后台查看运营数据

→ 阅读 ADMIN_DASHBOARD.md

---

文档关系图

README.md ────────────────── 项目入门概览
     │
     ├──→ PROJECT_DOCUMENTATION.md ──── 详细文档(部署/功能/前端更新)
     │
     ├──→ LOCAL_DEVELOPMENT_GUIDE.md ─── 本地开发环境设置
     │
     ├──→ SERVER_MANAGEMENT_GUIDE.md ─── 服务器运维
     │
     ├──→ frontend/
     │      ├── README.md ─────────────── 前端开发入门
     │      └── SWITCH_ENVIRONMENT.md ──── 环境切换
     │
     └──→ miniprogram/
            └── README.md ─────────────── 小程序开发入门

---

最后更新：2026/04/17