# ai-book

**Repository Path**: lc168/ai-book

## Basic Information

- **Project Name**: ai-book
- **Description**: 计划先实现web版本的md+关系图。
然后实现ai对文档和关系图的整理
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-19
- **Last Updated**: 2026-09-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Markdown Knowledge & Graph System

基于 FastAPI + Vue 的 Markdown 知识库与拓扑图谱系统。

---

## 🛠️ 环境准备与快速启动

本项目基于 Python 3.10+。请按照以下步骤配置系统依赖、Python 环境与启动服务。

### 1. 系统底层依赖安装（Debian / Ubuntu / Termux PRoot）

在 Linux 系统下，先安装 Python 基础工具、编译环境及核心原生库：

```bash
apt update && apt install -y python3 python3-pip python3-venv build-essential python3-bcrypt git
```

> **提示（ARM64 / aarch64 架构）**：  
> 强烈推荐通过系统包管理器安装 `python3-bcrypt`，可以规避在 ARM 平台因缺少 Rust / Cargo 工具链导致 pip 源码编译 `bcrypt` 失败的问题。

---

### 2. 文档仓库同步（`docs` 目录）

项目的文档内容独立保存在 `docs` 目录中（由后端存储引擎自动管理版本）。如果本地尚未下载文档仓库，可通过以下命令同步：

```bash
git clone https://gitee.com/lc168/doc_md.git docs
```

---

### 3. 配置 Python 运行环境与安装依赖

可以通过虚拟环境（推荐）或直接在系统 Python 环境中安装依赖：

#### 方案 A：使用虚拟环境（推荐）

```bash
# 1. 创建并激活虚拟环境
python3 -m venv venv
source venv/bin/activate

# 2. 安装 Python 项目依赖（推荐使用国内镜像加速）
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
```

#### 方案 B：直接系统环境安装

```bash
pip install --break-system-packages -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
```

---

### 4. 环境变量配置

复制环境变量示例文件：

```bash
cp .env.example .env
```

默认管理用户账号配置（可根据需要修改 `.env`）：
- 默认管理员账号：`admin`
- 默认密码：`admin123`

---

### 5. 启动服务

运行以下命令启动后端服务：

```bash
python3 run.py
```

服务启动后，默认监听在 `http://0.0.0.0:8000`。启动时系统会自动为 `docs` 目录建立搜索倒排索引与图谱拓扑缓存。

---

### 6. 运行自动化测试

验证系统功能与接口完整性：

```bash
pytest
```