# StudyingSpace - 个人学习空间

## 📖 项目简介

个人学习空间，帮助学习者记录学习过程、管理学习笔记，打造个性化的学习环境。

## ✨ 功能特性

### 🔐 用户系统

- [ ] 用户注册：创建个人账号
- [ ] 用户登录：安全登录个人空间

### 📅 每日打卡

- [ ] 每日学习打卡记录
- [ ] 打卡日历展示
- [ ] 连续打卡统计
- [ ] 学习时长记录

### 📝 笔记管理

- [ ] 笔记导入：支持从多种格式导入笔记
- [ ] 笔记导出：将笔记导出为常见格式
- [ ] 笔记分类与整理

## 🛠️ 技术栈

### 前端

- **框架**: Vue 3
- **构建工具**: Vite

### 后端

- **框架**: Spring Boot
- **语言**: Java
- **数据库**: PostgreSQL

## 📁 项目结构

项目采用前后端分离架构，代码分别存放于两个目录：

```
StudyingSpace/
├── frontend/          # 前端代码 (Vue 3 + Vite)
└── backend/           # 后端代码 (Spring Boot)
```

## 🚀 快速开始

### 环境要求

- Node.js (前端)
- JDK 21+ (后端)
- PostgreSQL

### 安装步骤

### 运行项目

## 🐳 Docker 快速部署

你可以直接使用 Docker 一键部署整个应用，无需本地配置 Java/Node.js/PostgreSQL。

### 前置要求

- 安装 [Docker Desktop](https://www.docker.com/products/docker-desktop/)
- Docker Desktop 已启动

### 部署步骤

1. 克隆项目到本地：

```bash
git clone https://github.com/hetianci/StudyingSpace.git
cd StudyingSpace
```

1. 直接运行：

```bash
docker compose up -d
```

项目中已经包含 `docker-compose.yml`，会自动从 Docker Hub 拉取镜像并启动。

### 访问应用

启动成功后，打开浏览器访问：

- 后端 API: <http://localhost:8080>
- Swagger API 文档: <http://localhost:8080/swagger-ui.html>

### 常用命令

```bash
# 查看运行状态
docker compose ps

# 查看后端日志
docker compose logs backend

# 实时查看日志
docker compose logs -f backend

# 停止所有容器
docker compose down

# 停止但保留数据
docker compose stop

# 重新启动
docker compose start

# 更新到最新镜像
docker compose pull
docker compose up -d
```

### 注意事项

- 如果本地 5432 端口已被占用，需要先停止本地 PostgreSQL 服务，或者修改 `docker-compose.yml` 中的端口映射
- 数据库数据会保存在 Docker 卷 `postgres-data` 中，即使删除容器数据也不会丢失
- 首次启动会自动拉取镜像，需要等待一段时间

## 📖 使用文档

### 用户注册登录

### 每日打卡使用

### 笔记导入导出

## 📈 开发计划

- [ ] 第一阶段：用户登录注册功能
- [ ] 第二阶段：每日打卡功能
- [ ] 第三阶段：笔记导入导出功能
- [ ] 后续：更多功能扩展

## 🤝 贡献指南

## 📄 许可证