# QuickMD

**Repository Path**: twinkle_/quick-md

## Basic Information

- **Project Name**: QuickMD
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-27
- **Last Updated**: 2026-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# X-Markdown 笔记管理系统

基于 Spring Boot + Vue 3 构建的现代化 Markdown 笔记管理应用。

## 技术栈

### 后端
- Java 21
- Spring Boot 3.2.x
- Spring Security + JWT
- SQLite (嵌入式数据库)
- Lombok

### 前端
- Vue 3 + Vite
- Ant Design Vue 4.x
- Pinia 状态管理
- Marked (Markdown解析)
- Highlight.js (代码高亮)

## 功能特性

- ✅ 用户登录/注册
- ✅ JWT 安全认证
- ✅ 目录管理（树形结构）
- ✅ Markdown 编辑器与预览
- ✅ 笔记创建/编辑/删除
- ✅ 美观的UI设计

## 快速开始

### 环境要求

- JDK 21+
- Node.js 18+
- Maven

### 启动后端

```bash
cd backend
mvn spring-boot:run
```

后端服务运行在 `http://localhost:8080`

### 启动前端

```bash
cd frontend
npm install
npm run dev
```

前端服务运行在 `http://localhost:5173`

## API 接口

### 认证接口
- `POST /api/auth/register` - 用户注册
- `POST /api/auth/login` - 用户登录

### 目录接口
- `GET /api/directories` - 获取目录树
- `POST /api/directories` - 创建目录
- `PUT /api/directories/{id}` - 更新目录
- `DELETE /api/directories/{id}` - 删除目录

### 笔记接口
- `GET /api/notes/{id}` - 获取笔记详情
- `POST /api/notes` - 创建笔记
- `PUT /api/notes/{id}` - 更新笔记
- `DELETE /api/notes/{id}` - 删除笔记

## 项目结构

```
x-markdown/
├── backend/                    # 后端 Spring Boot 项目
│   ├── src/main/java/          # Java 源代码
│   ├── src/main/resources/     # 配置文件
│   └── pom.xml                 # Maven 依赖
├── frontend/                   # 前端 Vue 项目
│   ├── src/                    # Vue 源代码
│   │   ├── components/         # 组件
│   │   ├── stores/             # Pinia 状态管理
│   │   ├── utils/              # 工具函数
│   │   ├── views/              # 页面视图
│   │   ├── router/             # 路由配置
│   │   └── main.js             # 入口文件
│   └── package.json            # npm 依赖
└── README.md                   # 项目说明
```

## 安全特性

- JWT Token 认证
- BCrypt 密码加密
- CORS 跨域配置
- 请求参数验证
- 全局异常处理