Skip to content

hazelian0619/SmartCampus

Repository files navigation

🏫 SmartCampus - 智慧校园小程序

一个现代化的微信小程序项目,用于校园信息管理和服务平台。

📋 项目概述

SmartCampus 提供了以下核心功能:

  • 首页 - 校园动态和快速导航
  • 告警管理 - 实时告警通知和历史查询
  • 数据图表 - 可视化数据展示和分析
  • 工单系统 - 服务工单创建和跟踪
  • 个人中心 - 用户信息和设置管理

🏗️ 项目结构(工业级标准)

SmartCampus/
├── src/                          # 📁 源代码目录
│   ├── components/               # 🧩 UI组件库(可复用组件)
│   │   ├── chart-card/          # 图表卡片组件
│   │   ├── chart-selector/      # 图表选择器组件
│   │   └── ec-canvas/           # ECharts画布组件
│   ├── pages/                    # 📄 页面模块(业务)
│   │   ├── index/               # 首页
│   │   ├── alarm/               # 告警模块
│   │   ├── chart/               # 图表模块
│   │   ├── profile/             # 个人中心
│   │   ├── login/               # 登录页面
│   │   └── ticket/              # 工单管理
│   ├── services/                # 🔌 API 服务层
│   │   └── api.js               # API 接口定义
│   ├── utils/                   # 🛠️ 工具函数库
│   ├── stores/                  # 💾 全局状态管理
│   ├── constants/               # ⚙️ 常量定义
│   ├── styles/                  # 🎨 全局样式文件
│   ├── mockdata/                # 📋 测试数据
│   ├── app.js                   # 应用配置副本
│   └── app.json                 # 应用配置副本
├── docs/                         # 📚 项目文档
│   ├── DEVELOPMENT.md            # 开发指南
│   ├── API.md                    # API 文档
│   ├── PROJECT_STRUCTURE.md      # 详细结构说明
│   └── CHANGELOG.md              # 版本更新日志
├── requirements/                 # 📋 需求文档
│   ├── 需求拆解/
│   ├── 方案/
│   └── 团队流程/
├── 配置文件
│   ├── app.js                    # ⭐ 小程序入口(根目录)
│   ├── app.json                  # ⭐ 小程序配置(根目录)
│   ├── project.config.json       # 微信开发者工具配置
│   ├── project.private.config.json
│   ├── package.json              # NPM 项目配置
│   ├── .eslintrc.json            # ESLint 规则配置
│   ├── .prettierrc.json          # 代码格式化配置
│   ├── .gitignore                # Git 忽略规则
│   └── .env.example              # 环境变量模板
└── README.md                     # 项目说明

🚀 快速开始

环境要求

  • Node.js 14.0+
  • 微信开发者工具(最新版本)
  • Git

安装步骤

  1. 克隆项目
git clone https://github.com/hazelian0619/SmartCampus.git
cd SmartCampus
  1. 安装依赖
npm install
  1. 开发环境配置
cp .env.example .env
# 编辑 .env 文件,配置 API 地址等参数
  1. 打开微信开发者工具
  • 选择项目根目录
  • 使用项目的 AppID
  • 点击"编译"进行预览
  • 使用手机扫描预览二维码

代码规范

本项目遵循工业级代码规范:

  • ✅ ESLint 代码检查(见 .eslintrc.json
  • ✅ Prettier 自动格式化(见 .prettierrc.json
  • ✅ Git 提交规范(见 docs/DEVELOPMENT.md
  • ✅ 目录结构规范(见 docs/PROJECT_STRUCTURE.md

📝 开发指南

代码修改流程

  1. 创建功能分支
git checkout develop
git checkout -b feature/your-feature-name
  1. 在 src/ 目录下开发
# 添加新页面
mkdir -p src/pages/new-page
# 创建组件、服务等
  1. 本地测试
# 在微信开发者工具中编译预览
  1. 提交代码
git add .
git commit -m "feat: add new feature description"
git push origin feature/your-feature-name
  1. 创建 Pull Request,等待代码审查

快速任务

添加新页面

参考 docs/DEVELOPMENT.md

创建可复用组件

参考 docs/DEVELOPMENT.md

调用 API

参考 docs/API.md

📚 完整文档

文档 说明
README.md 项目概览(本文档)
docs/DEVELOPMENT.md 开发指南(重点阅读)
docs/PROJECT_STRUCTURE.md 项目结构详解
docs/API.md API 接口文档

建议首先阅读 开发指南

🤝 团队协作

请参考 requirements/团队流程 了解:

  • 开发工作流程
  • 代码审查标准
  • 版本发布流程

🔧 常见问题

Q: 如何添加新页面?

A: 见 docs/DEVELOPMENT.md - 任务 1

Q: src 目录下的 app.js 和 app.json 有什么用?

A: 备份和版本控制。实际运行时使用根目录的文件。

Q: 如何配置 API 地址?

A: 编辑 .env 文件,参考 .env.example

Q: 如何调试数据接口?

A: 在微信开发者工具中打开网络 tab,查看请求和响应

Q: 为什么有 .eslintrc.json 和 .prettierrc.json?

A: 保证代码风格统一。建议在 IDE 中安装对应插件自动格式化。

📦 部署和发布

生成体验版

  1. 在微信开发者工具中点击"上传"
  2. 输入版本号和描述
  3. 生成体验版二维码

发布正式版

  1. 完成代码审查并合并到 main 分支
  2. 更新版本号和更新日志
  3. 配置审核信息
  4. 提交审核
  5. 等待微信审核通过后发布

📋 项目信息

  • 项目名称: SmartCampus(智慧校园)
  • 项目类型: 微信小程序
  • 开发语言: JavaScript、WXML、WXSS
  • 主要功能: 校园信息服务、告警管理、数据展示
  • 维护者: hazelian0619
  • 创建时间: 2026年2月

📄 许可证

此项目版权归校园信息中心所有。

👥 贡献者

欢迎提交 Issue 和 Pull Request!


最后更新: 2026年2月5日

文档版本: v2.0 - 工业级标准项目重组

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors