NoteGen 开源项目使用教程

1. 项目介绍

NoteGen 是一款专注于记录和写作的跨端 AI 笔记应用，基于 Tauri 开发。它将记录、写作和 AI 结合使用，三者相辅相成，帮助用户快速捕捉和整理碎片化知识，并支持从零到一的创作过程。

2. 项目快速启动

首先，确保您的开发环境中已安装以下依赖：

• Node.js
• Rust（用于构建 Tauri 应用）

以下是快速启动 NoteGen 的步骤：

# 克隆项目到本地
git clone https://github.com/codexu/note-gen.git

# 进入项目目录
cd note-gen

# 安装依赖
npm install

# 构建项目
npm run build

# 运行项目
npm start

3. 应用案例和最佳实践

应用案例

• 记录功能：支持多种记录方式，如截图、文本、插图、文件等，方便用户快速捕捉和整理知识。
• 写作功能：提供文件管理器、所见即所得编辑器、版本控制等，辅助用户完成写作过程。
• AI 辅助：集成多种 AI 功能，如问答、续写、优化、精简、翻译等，提高写作效率。

最佳实践

• 使用自定义标签：为不同类型的记录分类，便于管理和查找。
• 利用 AI 对话：与 AI 对话，获取灵感或辅助写作。
• 同步至 GitHub：将笔记同步至 GitHub 仓库，确保数据安全。

4. 典型生态项目

• Tauri：NoteGen 的基础框架，提供跨平台能力。
• Next.js：用于构建 NoteGen 的前端框架。
• shadcn-ui：NoteGen 使用的 UI 库，提供美观的界面组件。
• OpenAI：NoteGen 集成的 AI 模型，提供智能写作辅助。