Files
NovalRedot/README.md

70 lines
1.6 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Noval
小说创作应用本地Web形式集成AI Agent辅助创作。
## 功能
- **小说管理** — 创建、编辑、删除小说作品
- **大纲管理** — 卷轴时间线可视化展示,拖拽排序
- **AI对话** — 流式对话Agent支持OpenAI兼容API和Anthropic原生API
- **上下文窗口** — Token用量统计进度条
## 技术栈
| 层 | 技术 |
|---|------|
| 后端 | Python + FastAPI + SQLModel + SQLite |
| 前端 | Vue 3 + Vite + TypeScript |
| AI | httpx直调OpenAI/Anthropic API无SDK依赖 |
| UI | 纯手写组件,"墨韵书斋"设计风格 |
## 快速开始
### 后端
```bash
cd backend
py -3 -m venv .venv
.venv/Scripts/pip install -r requirements.txt
.venv/Scripts/uvicorn app.main:app --port 8000
```
### 前端
```bash
cd frontend
npm install
npm run dev
```
打开浏览器访问 http://localhost:5173
### AI配置
1. 点击右下角聊天按钮
2. 点击齿轮图标打开AI配置
3. 选择服务商OpenAI兼容 / Anthropic
4. 填入API地址、API Key、模型名称
5. 点击"测试连接"验证后保存
## 项目结构
```
noval/
├── backend/ # FastAPI后端
│ └── app/
│ ├── models.py # 数据模型
│ ├── routers/ # API路由
│ └── services/ # AI Provider
└── frontend/ # Vue 3前端
└── src/
├── components/ # UI组件
├── views/ # 页面
├── api/ # API调用
└── composables/ # 组合式函数
```
## 许可证
开源项目,欢迎贡献。