# sleep-space

**Repository Path**: htao001/sleep-space

## Basic Information

- **Project Name**: sleep-space
- **Description**: 这是一个学习项目，用于巩固学习
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-08
- **Last Updated**: 2026-01-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 知渡 - 学习资源管理系统

一个基于 Flask + React 的全栈学习资源管理系统，支持资源收藏、笔记管理、实时私信、用户关注等功能。

## ✨ 核心功能

- 📚 **资源管理** - 浏览、搜索、收藏学习资源
- 📝 **笔记系统** - 创建和管理学习笔记
- 🤖 **AI 智能助手** - 本地 AI 模型，无需 API Key，完全私密
- 💬 **实时私信** - WebSocket实时通信，支持在线状态和输入提示
- 👥 **用户关注** - 关注感兴趣的用户，查看他们的资源
- 🔔 **消息通知** - 实时接收系统通知
- 🛠️ **实用工具** - 集成各类学习辅助工具
- 👤 **用户系统** - 完整的用户认证和个人主页

## 🚀 技术栈

### 后端
- **框架**: Flask 2.0.1
- **数据库**: SQLAlchemy + SQLite
- **认证**: JWT
- **实时通信**: Flask-SocketIO + Gevent
- **密码加密**: bcrypt
- **AI 模型**: Transformers + PyTorch (ChatGLM3-6B)

### 前端
- **框架**: React 18.2.0
- **构建工具**: Vite 5.0.8
- **路由**: React Router DOM 6.22.3
- **样式**: Tailwind CSS 3.4.1
- **实时通信**: Socket.IO Client
- **富文本编辑器**: TipTap 2.1.13

## 📁 项目结构

```
├── backend/                 # 后端 Flask 应用
│   ├── app/                # 应用核心代码
│   │   ├── api/           # API 路由
│   │   ├── models/        # 数据模型
│   │   ├── services/      # 业务逻辑
│   │   └── utils/         # 工具函数
│   ├── requirements.txt   # Python 依赖
│   ├── run.py            # 应用入口
│   └── Dockerfile        # 后端容器配置
├── frontend/               # 前端 React 应用
│   ├── src/               # 源代码
│   │   ├── components/    # React 组件
│   │   ├── pages/         # 页面组件
│   │   ├── services/      # API 服务
│   │   └── utils/         # 工具函数
│   ├── package.json       # Node.js 依赖
│   └── Dockerfile         # 前端容器配置
└── docker-compose.yml      # 容器编排配置
```

## 🛠️ 快速开始

### 前置要求
- Python 3.9+
- Node.js 16+
- npm 或 yarn
- （可选）NVIDIA GPU + CUDA（用于 AI 加速）

### 后端设置

1. **进入后端目录并创建虚拟环境**
   ```bash
   cd backend
   python -m venv venv
   source venv/bin/activate  # Linux/Mac
   ```

2. **安装依赖**
   ```bash
   pip install -r requirements.txt
   ```

3. **配置环境变量**
   ```bash
   cp .env.example .env
   # 编辑 .env 文件
   ```

4. **初始化数据库**
   ```bash
   python init_system_config.py
   python init_admin.py
   ```

5. **启动后端服务**
   ```bash
   python run.py
   ```
   后端将运行在 http://localhost:5000

### 前端设置

1. **进入前端目录**
   ```bash
   cd frontend
   ```

2. **安装依赖**
   ```bash
   npm install
   ```

3. **配置环境变量**
   ```bash
   cp .env.example .env
   ```

4. **启动开发服务器**
   ```bash
   npm run dev
   ```
   前端将运行在 http://localhost:3000

## 🔑 默认账号

首次运行后，使用以下账号登录：
- 管理员账号：在运行 `init_admin.py` 时设置
- 普通用户：可通过注册页面创建

## 📱 主要功能说明

### 私信系统
- 实时消息推送（WebSocket）
- 在线状态显示
- 正在输入提示
- 未互相关注用户只能发送一条消息
- 互相关注后可无限制私信

### 关注系统
- 关注/取消关注用户
- 查看关注列表和粉丝列表
- 回关功能
- 查看用户主页和资源

### 资源管理
- 按类型、难度筛选资源
- 收藏感兴趣的资源
- 查看资源作者
- 创建和分享自己的资源

### AI 智能助手
- 使用智谱 AI API（GLM-4-Flash）
- 响应速度快（1-3秒）
- 免费额度充足（1000万 tokens）
- 无需下载模型
- 配置说明：[AI_API_SETUP.md](AI_API_SETUP.md)

#### 认识球球 🎀
球球是知渡的 AI 智能助手，一个活泼可爱、温柔体贴的 AI 小姐姐！

**球球的特点**:
- 🌸 活泼开朗，说话温柔可爱
- 💕 充满正能量，总是鼓励用户
- 📚 熟悉知渡系统的所有功能
- 🛠️ 能帮助解决技术问题
- ✨ 可以推荐学习资源和制定学习计划

**球球能做什么**:
- 回答系统使用问题
- 推荐学习资源
- 制定学习计划
- 提供技术支持
- 解答部署问题

详细了解：[AI 知识库](docs/ai-knowledge/)

## 🌐 生产环境部署

### 快速部署（推荐）
查看 [快速开始指南](QUICK_START.md) - 5分钟快速部署到服务器

### 完整部署文档
查看 [完整部署指南](DEPLOYMENT.md) - 包含详细的配置和优化说明

### 一键部署脚本
```bash
# 克隆项目到服务器
git clone <repository-url> /opt/sleep-space
cd /opt/sleep-space

# 配置环境变量
cp backend/.env.example backend/.env
cp frontend/.env.example frontend/.env
# 编辑配置文件...

# 执行部署
chmod +x deploy.sh
./deploy.sh init
```

### Docker 部署
```bash
# 开发环境
docker-compose up -d

# 生产环境
docker-compose -f docker-compose.prod.yml up -d
```

### 访问应用
- **前端**: http://your-server-ip 或 https://your-domain.com
- **后端 API**: http://your-server-ip/api
- **健康检查**: http://your-server-ip/api/health