# ai-doc-correction

**Repository Path**: justit/ai-doc-correction

## Basic Information

- **Project Name**: ai-doc-correction
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-24
- **Last Updated**: 2026-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



Based on the code map analysis, I can see this is an AI document correction system built with Nuxt.js, Tailwind CSS, and MySQL (via Prisma). Let me create a comprehensive README.md file.

# AI 文档纠错系统

AI 文档纠错系统是一款基于人工智能技术的文档纠错工具，支持用户上传文档、智能识别并纠正文档中的错误内容。

## 技术栈

- **前端框架**: Nuxt.js 3
- **样式方案**: Tailwind CSS
- **后端**: Nuxt Server Routes (Nitro)
- **数据库**: MySQL + Prisma ORM
- **认证**: JWT Token
- **容器化**: Docker

## 功能特性

- 用户注册与登录
- 文档上传与管理
- AI 智能纠错
- 纠错历史记录
- 一键下载纠错后的文档

## 快速开始

### 环境要求

- Node.js >= 18
- MySQL >= 5.7
- Docker & Docker Compose (可选)

### 本地开发

1. 安装依赖：

```bash
npm install
```

2. 配置环境变量：

```bash
cp .env.example .env
# 编辑 .env 文件，配置数据库连接和 AI API Key
```

3. 初始化数据库：

```bash
npx prisma migrate dev
```

4. 启动开发服务器：

```bash
npm run dev
```

### Docker 部署

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

服务将在 `http://localhost:3000` 可访问。

## 项目结构

```
├── pages/              # 页面路由
│   ├── index.vue       # 上传/仪表盘页面
│   ├── login.vue      # 登录页面
│   ├── register.vue   # 注册页面
│   ├── history.vue   # 历史记录页面
│   └── upload/[id].vue  # 纠错详情页
├── server/             # 服务端 API
│   ├── api/           # API 路由
│   │   ├── auth/      # 认证接口
│   │   ├── correction/  # 纠错接口
│   │   └── upload.post.ts
│   ├── middleware/    # 中间件
│   └── utils/         # 工具函数
├── prisma/             # 数据库模型
│   └── schema.prisma
├── composables/       # Vue 组合式函数
├── stores/            # Pinia 状态管理
└── assets/            # 静态资源
```

## 核心页面

| 页面 | 路由 | 说明 |
|-----|------|------|
| 登录 | `/login` | 用户登录 |
| 注册 | `/register` | 用户注册 |
| 上传 | `/` | 文档上传与纠错 |
| 详情 | `/upload/:id` | 查看纠错结果 |
| 历史 | `/history` | 纠错历史记录 |

## 配置说明

主要环境变量：

| 变量名 | 说明 | 默认值 |
|--------|------|--------|
| `DATABASE_URL` | MySQL 数据库连接串 | - |
| `JWT_SECRET` | JWT 密钥 | - |
| `AI_API_KEY` | AI 服务 API Key | - |
| `AI_BASE_URL` | AI 服务地址 | - |

## 许可证

MIT License