# SchoolDataServer

**Repository Path**: lisoul/school-data-server

## Basic Information

- **Project Name**: SchoolDataServer
- **Description**: SchoolDataServer：一个专注于学校数据管理的开源项目，提供高效的数据存储、查询与分析服务，旨在简化校园信息管理流程。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-19
- **Last Updated**: 2026-02-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🎓 智慧校园数据服务系统 (Smart Campus Data Service System)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Bun](https://img.shields.io/badge/Runtime-Bun-black?logo=bun)](https://bun.sh)
[![React](https://img.shields.io/badge/Frontend-React-61DAFB?logo=react)](https://reactjs.org)
[![MySQL](https://img.shields.io/badge/Database-MySQL-4479A1?logo=mysql)](https://www.mysql.com/)

智慧校园数据服务系统是一个面向教育行业的全栈式数据 management 平台。系统采用前后端分离架构，提供从省级教育主管部门到学生个体的全层级、多维度数据服务，旨在实现校园管理的数字化、智能化和精细化。

---

## 🌟 核心功能

### 1. 全方位校园业务模块 (共19个子系统)
系统涵盖了学校运行的各个核心环节：

*   **基础管理**：核心数据管理、系统配置、角色权限控制。
*   **教务德育**：教务管理、教研活动、德育评价、学生成长档案。
*   **行政办公**：办公事务管理、请假审批、会议管理。
*   **校园服务**：教师服务、学生服务、校友/家校共育、退餐管理。
*   **安全后勤**：校园安全监控、资产管理、后勤保障、网络管理。
*   **考核评价**：全自动化的评估评价系统。

### 2. 高级系统特性
*   **🚀 高性能后端**：基于 Bun + Koa 的极速响应，支持大规模数据并发处理。
*   **🔗 强大的 Webhook 系统**：提供灵活的事件订阅和第三方系统集成机制。
*   **📡 实时通信**：集成 WebSocket 调度器，实现消息实时推送。
*   **🌐 内网穿透**：内置 NPS 配置支持，方便在复杂网络环境下进行部署和访问。
*   **📊 多平台构建**：支持一键构建多平台可执行文件。

---

## 🛠️ 技术栈

### 前端 (Client)
- **框架**: React 18 + Vite
- **语言**: TypeScript
- **样式**: Tailwind CSS
- **构建工具**: Vite

### 后端 (Server)
- **运行时**: [Bun](https://bun.sh) (极速 JavaScript 运行时)
- **Web 框架**: Koa
- **数据库**: MySQL 8.0+ / PostgreSQL 支持
- **SQL 构建器**: Knex.js

### 部署与工具
- **容器化**: Docker
- **内网穿透**: NPS
- **API 测试**: Postman

---

## 📂 项目结构

```text
.
├── client/          # 前端 React 项目
├── server/          # 后端 Bun/Koa 项目
├── database/        # 数据库初始化脚本 (MySQL/Postgres)
├── docs/            # 详细的业务设计和技术文档
├── scripts/         # 快速启动与管理脚本
└── nps.conf         # 内网穿透配置
```

---

## 🚀 快速开始

### 1. 环境准备
确保已安装 [Bun](https://bun.sh)。

### 2. 交互式启动 (推荐)
```bash
# 运行项目启动脚本
./scripts/start-project.bat  # Windows
# 或
./start.sh                   # Linux/macOS
```

### 3. 手动启动
```bash
# 安装后端依赖并启动
cd server && bun install
bun run dev

# 安装前端依赖并启动
cd ../client && bun install
bun run dev
```

---

## 📖 文档中心

详细文档请参考：
- **[📚 文档索引](./DOCUMENTATION.md)** - 快速找到所需信息
- **[📖 文档中心](./docs/README.md)** - 业务逻辑与详细配置指南
- **[📡 API 接口说明](./docs/04-api/webhook-api.postman_collection.json)**

---

## 📄 开源协议
本项目采用 [MIT License](LICENSE) 开源协议。

---
**项目版本**: 1.0.0  
**开发人员**: LiSoul  
**最后更新**: 2026-01-19  
**维护状态**: 活跃更新中