# scribe-ai

**Repository Path**: zeus-maker/scribe-ai

## Basic Information

- **Project Name**: scribe-ai
- **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-04-21
- **Last Updated**: 2026-05-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Scribe AI（AI 写作网站系统）

面向网文与短剧创作者的 **AI 辅助写作平台**：创作工作台、会话与作品管理、技能广场、管理后台与内容审核等能力；后端基于 **FastAPI**，用户端与管理端为 **React + Vite + TypeScript + Ant Design**。

更完整的产品与接口说明见仓库内规范文档：[`.spec/spec.md`](.spec/spec.md)。

---

## 仓库结构

| 目录 | 说明 |
|------|------|
| [`backend/`](backend/) | Python 3.12 + FastAPI，REST API、JWT 鉴权、PostgreSQL、Redis、AI 流式对话等 |
| [`frontend-user/`](frontend-user/) | 创作者前台：登录注册、工作台、作品、技能、个人中心 |
| [`frontend-admin/`](frontend-admin/) | 运营后台：仪表盘、审核、用户、模型配置、额度、技能与作品管理等 |
| [`nginx/`](nginx/) | 统一入口反向代理：`/` 用户端、`/admin/` 管理端、`/api/` 后端 |
| [`docker-compose.yml`](docker-compose.yml) | 本地/一体化编排：PostgreSQL、Redis、后端、双前端、Nginx |

各子目录另有独立 **README**，便于只开发某一端时快速上手。

---

## 环境要求

- **Docker**（可选，用于数据库、Redis 与一体化启动）
- **Node.js** 20+（前端）
- **Python** 3.12+（后端）
- **PostgreSQL** 16、**Redis** 7（若不用 Docker 则需本机安装）

---

## 快速开始（推荐：本机开发）

### 1. 启动数据库与 Redis

```bash
docker compose up -d db redis
```

### 2. 后端

```bash
cd backend
cp .env.example .env
# 按需编辑 .env：数据库、Redis、短信/OSS、AI API Key 等

python -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -r requirements.txt

# 有迁移版本后执行（当前若尚无 versions 可跳过）
# alembic upgrade head

uvicorn app.main:app --reload --host 0.0.0.0 --port 8000
```

健康检查：<http://localhost:8000/health>  
API 前缀默认为：`/api/v1`（见 `backend/.env.example` 中 `APP_API_PREFIX`）。

### 3. 用户端前端

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

默认开发地址一般为 <http://localhost:5173>（Vite 默认端口）；`/api` 已代理到本机 `8000`。

### 4. 管理端前端

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

开发服务器端口为 **5174**（见 `frontend-admin/vite.config.ts`）。

---

## Docker Compose 全栈说明

```bash
docker compose up --build
```

编排包含：`db`、`redis`、`backend`、`frontend-user`、`frontend-admin`、`nginx`。

- **注意**：根目录 `docker-compose.yml` 中前端服务使用 `build: ./frontend-user` 与 `./frontend-admin`。若尚未在各前端目录提供 **Dockerfile**，`docker compose build` 会失败；可优先使用上文「本机开发」方式，或自行补充前端镜像构建文件后再全量构建。
- 后端需准备 `backend/.env`（可从 `.env.example` 复制）。
- Nginx 将 **用户端** 挂在 `/`，**管理端** 挂在 `/admin/`，API 为 `/api/`（详见 `nginx/nginx.conf`）。

---

## 常用脚本

| 位置 | 命令 | 作用 |
|------|------|------|
| `frontend-user` / `frontend-admin` | `npm run dev` | 本地开发 |
| 同上 | `npm run build` | 生产构建 |
| 同上 | `npm run lint` | ESLint |
| `backend` | `uvicorn app.main:app --reload --port 8000` | 本地 API |
| `backend` | `alembic upgrade head` | 数据库迁移（有版本文件后） |

---

## 配置要点（后端 `.env`）

主要变量说明见 `backend/.env.example`，包括：

- **DATABASE_URL**：异步 PostgreSQL 连接（运行时使用 `asyncpg`）
- **REDIS_URL**：缓存与会话等
- **APP_SECRET_KEY**、JWT 相关：鉴权与安全
- **阿里云短信 / OSS**：登录验证码与文件存储（可按环境留空或填测试值）
- **DEEPSEEK_*** / **QWEN_***：第三方大模型调用
- **CORS_ORIGINS**：浏览器跨域来源列表

---

## 文档与改进

- 产品规格：`.spec/spec.md`
- 各模块细节请结合子目录 README 与源码中的路由、页面结构阅读。

若你发现文档与代码不一致（例如端口、环境变量名变更），欢迎直接更新对应 README 或本文件，保持新人可一键跑通。