GraphNote - AI 驱动的知识管理工具

GraphNote 是一个创新的笔记应用，通过 AI 驱动的关系图可视化帮助用户组织和管理知识。输入文本后，应用会自动提取关键实体和关系，生成交互式知识图谱，让用户能够更直观地理解信息间的联系。

详细的使用说明、API 文档、项目结构与测试指南见 MANUAL.md，整体架构设计见 ARCHITECTURE.md。

特性概览

• 智能关系图生成：AI 自动从文本中提取实体和关系，生成可视化知识图谱
• 交互式图表编辑：拖拽节点、编辑节点/边属性、撤销重做、自定义样式
• 富文本笔记编辑：Markdown 支持、代码高亮、图片和链接
• 多用户与数据持久化：注册登录、个人笔记管理，数据保存到 PostgreSQL
• 版本控制：记录修改历史，支持一键回滚
• 数据导出：JSON / CSV
• 笔记分享：每个笔记有唯一 shareId，可公开分享

技术栈：Vue 3 + Vite + TailwindCSS + Pinia（前端），Express + Prisma + PostgreSQL（后端），G6 图谱渲染，任意 OpenAI 兼容 LLM 接口。

---

环境变量（集中在项目根 .env）

所有配置集中在一个文件——项目根目录的 .env。前后端本地开发与 Docker 部署都从这里读取，无需在各子目录维护单独的 .env。复制模板即可：cp .env.example .env。.env 已在 .gitignore 中忽略（含密钥不提交），.env.example 作为模板纳入版本库。

变量	归属	说明	示例 / 默认
PORT	后端	端口	3000
NODE_ENV	后端	环境	development / production
DATABASE_URL	后端	PostgreSQL 连接串	postgresql://user:pass@localhost:5432/db
JWT_SECRET	后端	JWT 密钥（生产必填）	openssl rand -hex 32
JWT_EXPIRATION	后端	access token 有效期	1h
JWT_REFRESH_EXPIRATION	后端	refresh token 有效期	7d
CORS_ORIGIN	后端	允许跨域来源（逗号分隔）	http://localhost:5173
LLM_API_KEY	后端	LLM 密钥	从服务商获取
LLM_BASE_URL	后端	OpenAI 兼容接口地址	https://api.openai.com/v1
LLM_MODEL	后端	模型名称	gpt-4.1-nano
VITE_API_BASE_URL	前端	后端 API 地址（仅 VITE_ 前缀会暴露给浏览器）	http://localhost:3000/api（Docker 为 /api）

读取方式：本地后端 npm run dev 由 backend/src/main.ts 加载根 .env；本地前端由 Vite 的 envDir 从根 .env 读取 VITE_ 变量；Docker 部署由 docker-compose.yml 的 ${VAR} 解析根 .env。

---

本地运行

方式一：Docker Compose（推荐，一键启动）

仓库根目录提供 docker-compose.yml，包含 PostgreSQL、后端、前端（nginx）三个服务，只需暴露一个端口。

配置密钥：在项目根目录创建 .env（与 docker-compose.yml 同级，docker compose 会自动加载），写入：

JWT_SECRET=用_openssl_rand_-hex_32_生成的随机值LLM_API_KEY=你的_api_keyLLM_BASE_URL=https://api.openai.com/v1LLM_MODEL=gpt-4.1-nano

Docker 部署只需在根 .env 中设置 JWT_SECRET / LLM_* / CORS_ORIGIN（其余如 DATABASE_URL、PORT 已由 docker-compose.yml 内置）。.env 已在 .gitignore 中，不会被提交。

构建并后台启动：

docker compose up -d --build

后端启动时会自动执行 prisma migrate deploy 完成数据库初始化，无需手动迁移。

• 前端：http://localhost:8080
• 后端 API：http://localhost:8080/api（由前端 nginx 反向代理到后端容器）

docker compose logs -f backend # 查看后端日志
docker compose ps # 查看服务状态
docker compose down # 停止（数据保留在 postgres_data 卷）
docker compose down -v # 停止并删除数据库数据

如需改端口，修改 docker-compose.yml 中 frontend 的 ports 与后端的 CORS_ORIGIN。

方式二：手动开发模式

前置：Node.js 18+、PostgreSQL 14+（或单独 docker run 一个 postgres 容器）。

1. 在项目根创建 .env：

cp .env.example .env # 按上面的表格填写 DATABASE_URL / JWT_SECRET / LLM_* / VITE_API_BASE_URL

2. 后端（终端 1）：

cd backend
npm install
npm run prisma:generate
npm run prisma:migrate # 创建数据库表结构
npm run dev # http://localhost:3000（自动读取根 .env）

3. 前端（终端 2）：

cd graphnote-web
npm install
npm run dev # http://localhost:5173（自动读取根 .env 的 VITE_API_BASE_URL）

打开 http://localhost:5173 注册账号并试用。本地开发只需维护项目根这一个 .env。

---

部署到腾讯云（绑定 graphnote.geekbit.org）

适用于：腾讯云香港服务器（轻量应用服务器 / CVM均可），系统 Ubuntu 24.04，域名 geekbit.org 托管在 GoDaddy。 香港服务器无需 ICP 备案，域名解析生效即可访问。

下文以 <SERVER_IP> 表示服务器的公网 IP。

1. 服务器初始化与安装 Docker

SSH 登录服务器后：

# 更新系统
sudo apt update && sudo apt upgrade -y
# 安装 Docker 与 Compose 插件
sudo apt install -y docker.io docker-compose-v2
sudo systemctl enable --now docker
# 将当前用户加入 docker 组，使其免 sudo 使用 docker（必做）
sudo usermod -aG docker $USER# ⚠️ 组变更需重新登录后才生效：执行 exit 后重新连接 SSH；# 或在当前会话临时生效：newgrp docker

2. 拉取代码并配置

git clone <你的仓库地址>~/GraphNote
cd~/GraphNote

把环境变量写入 ~/GraphNote/.env（docker compose 会自动加载同目录 .env）：

cat >~/GraphNote/.env <<'EOF'JWT_SECRET=用_openssl_rand_-hex_32_生成LLM_API_KEY=你的_openai_兼容_api_keyLLM_BASE_URL=https://api.openai.com/v1LLM_MODEL=gpt-4.1-nanoCORS_ORIGIN=https://graphnote.geekbit.orgEOF

构建并启动（后端会自动执行 prisma migrate deploy）：

docker compose up -d --build

若报 permission denied ... docker.sock，说明上一步的 usermod 还未在当前会话生效——执行 newgrp docker（或退出 SSH 重连）后再重试该命令。不要改用 sudo docker compose，否则容器以 root 读写宿主文件会导致权限错乱。

此时服务已在本机 8080 端口运行，可用 curl http://localhost:8080/api/... 自测。

3. 域名解析（GoDaddy）

登录 GoDaddy → 进入 geekbit.org → 管理 DNS → 添加记录：

字段	值
类型	A
名称	graphnote
值	<SERVER_IP>
TTL	默认（600 / 1 Hour）

保存后等待解析生效，可在本地用 dig graphnote.geekbit.org 或 nslookup graphnote.geekbit.org 验证返回的 IP 是否为 <SERVER_IP>。

4. 开放端口

腾讯云控制台：服务器详情 → 防火墙 / 安全组，放行：

• 22（SSH）
• 80（HTTP，供 Certbot 完成 Let's Encrypt 证书校验与 HTTP→HTTPS 跳转）
• 443（HTTPS）

同时确认系统防火墙未拦截：

sudo ufw allow 22,80,443/tcp

5. 配置 HTTPS 反向代理（Nginx + Certbot）

在宿主机用 Nginx 把 graphnote.geekbit.org 反代到本机 8080（Docker 前端容器），再用 Certbot 申请 Let's Encrypt 证书——与你 elevator.geekbit.org 的做法一致。

安装 Nginx：

sudo apt install -y nginx

创建站点配置/etc/nginx/sites-available/graphnote：

sudo tee /etc/nginx/sites-available/graphnote >/dev/null <<'EOF'server { listen 80; server_name graphnote.geekbit.org; location / { proxy_pass http://127.0.0.1:8080; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; }}EOF

启用并重载（此时 http://graphnote.geekbit.org 应可访问，先确认域名解析已生效）：

sudo ln -s /etc/nginx/sites-available/graphnote /etc/nginx/sites-enabled/
sudo nginx -t && sudo systemctl reload nginx

申请 HTTPS 证书（Certbot 会自动改写 Nginx 配置启用 443、把 80 跳转到 443，并安装自动续期 certbot.timer，无需手动续期）：

sudo apt install -y certbot python3-certbot-nginx
sudo certbot --nginx -d graphnote.geekbit.org

6. 访问与验证

打开 **https://graphnote.geekbit.org**，注册账号、登录，输入文本点击"解析关系图"验证 AI 功能。

关于 CORS：前端经 Nginx 反代后，页面与 /api 同域（均走 https://graphnote.geekbit.org），浏览器同源请求不触发 CORS；CORS_ORIGIN 仍建议设为该域名。

常用运维命令

cd~/GraphNote
docker compose logs -f backend # 看后端日志
docker compose restart backend # 重启后端
git pull && docker compose up -d --build # 更新代码后重新部署
sudo tail -f /var/log/nginx/access.log # Nginx 访问日志
sudo certbot renew --dry-run # 验证证书自动续期是否正常

---

许可证

MIT License