NoteGen 项目部署指南

项目概览

NoteGen 是一款专注于知识管理的跨端 AI 笔记应用，采用 Tauri 2（跨平台桌面应用开发框架）构建，将碎片化信息记录与 AI 辅助写作深度融合。该应用以 TypeScript 为主要开发语言，支持多平台运行，旨在帮助用户高效捕捉、整理和扩展知识内容。

核心特性

1. 跨平台兼容：基于 Tauri 框架实现 Windows/macOS/Linux 多系统支持
2. AI 增强写作：集成 OpenAI 协议模型提供智能内容生成与优化
3. 轻量化设计：结合 Next.js 15 实现高效渲染与响应式界面
4. 知识管理系统：支持标签分类、内容搜索和版本控制
5. 离线优先：本地数据存储确保信息安全与访问可靠性

技术栈详解

技术名称	核心作用	版本要求
Tauri 2	跨平台应用框架	^2.0.0
Next.js	React 服务端渲染框架	15.x
shadcn-ui	UI 组件库	最新稳定版
Tailwind CSS	实用优先 CSS 框架	^3.0.0
TypeScript	强类型 JavaScript 扩展	^5.0.0

环境准备

前置依赖

🔧 基础软件安装

1. Node.js（LTS 版本，推荐 18.x 或更高）
   • 提供 JavaScript 运行环境和 npm 包管理工具
2. Git
   • 用于版本控制和项目克隆

验证安装：执行 node -v 和 git -v 命令检查版本信息

兼容性说明

• 操作系统：支持 Windows 10+、macOS 12+、Linux (Ubuntu 20.04+/Fedora 34+)
• 硬件要求：最低 4GB 内存，推荐 8GB+ 以确保 AI 功能流畅运行
• 网络环境：初始部署需联网下载依赖，部分 AI 功能需要持续网络连接

部署流程

1. 获取项目代码

🔧 克隆仓库

git clone https://gitcode.com/GitHub_Trending/no/note-gen [本地目录]

• 参数说明：[本地目录] 为可选参数，指定本地文件夹名称，不填则默认使用仓库名

2. 安装项目依赖

🔧 进入项目目录

cd note-gen

🔧 安装依赖包

npm install

该命令会根据 package.json 安装所有必要依赖，包括前端框架、UI 组件和开发工具

3. 配置环境变量

🔧 创建环境配置文件

touch .env.local

🔧 添加必要配置

# .env.local
NEXT_PUBLIC_API_URL=https://your-api-url.com
NEXT_PUBLIC_API_KEY=your-api-key

替换 your-api-url.com 和 your-api-key 为实际的 API 服务地址和访问密钥

4. 启动开发环境

🔧 运行开发服务器

npm run dev

• 启动成功后，应用将运行在 http://localhost:3000
• 首次启动可能需要几分钟时间进行资源编译

5. 构建生产版本（可选）

🔧 生成优化构建

npm run build

🔧 启动生产服务器

npm start

常见问题

依赖安装失败

• 症状：npm install 命令报错
• 解决方案：
  1. 检查 Node.js 版本是否符合要求
  2. 尝试清除 npm 缓存：npm cache clean --force
  3. 使用镜像源加速：npm install --registry=https://registry.npm.taobao.org

启动后无法访问

• 症状：浏览器访问 http://localhost:3000 无响应
• 解决方案：
  1. 检查端口是否被占用：netstat -tuln | grep 3000
  2. 查看终端错误信息，确认 API 配置是否正确
  3. 尝试删除 .next 目录后重新构建：rm -rf .next && npm run dev

AI 功能无法使用

• 症状：提示 "API 连接失败"
• 解决方案：
  1. 验证 .env.local 中的 API 地址和密钥
  2. 检查网络连接和防火墙设置
  3. 确认 API 服务是否正常运行