2026-03-21 10:13:29 +08:00
|
|
|
# Jarvis Backend
|
|
|
|
|
|
|
|
|
|
## 快速开始
|
|
|
|
|
|
|
|
|
|
### 1. 安装依赖
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
cd backend
|
|
|
|
|
uv sync
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### 2. 配置环境变量
|
|
|
|
|
|
|
|
|
|
```bash
|
2026-03-22 22:42:47 +08:00
|
|
|
cd ..
|
|
|
|
|
cp backend/.env.example .env
|
|
|
|
|
# 编辑项目根目录 .env
|
2026-03-21 10:13:29 +08:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### 3. 启动开发服务器
|
|
|
|
|
|
|
|
|
|
```bash
|
2026-03-22 22:42:47 +08:00
|
|
|
uv run uvicorn app.main:app --reload --host "$HOST" --port "$PORT"
|
2026-03-21 10:13:29 +08:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### 4. API 文档
|
|
|
|
|
|
2026-03-22 22:42:47 +08:00
|
|
|
启动后访问 `http://<HOST>:<PORT>/docs` 查看交互式 API 文档（以项目根目录 `.env` 中的 `HOST` 和 `PORT` 为准）。
|
2026-03-21 10:13:29 +08:00
|
|
|
|
|
|
|
|
## 环境变量
|
|
|
|
|
|
|
|
|
|
见 `.env.example`
|
|
|
|
|
|
|
|
|
|
## 数据库
|
|
|
|
|
|
|
|
|
|
SQLite 数据库位于 `./data/jarvis.db`，首次启动自动创建表。
|
