NoteGen 开源项目使用与启动教程

NoteGen 开源项目使用与启动教程

note-gen 一款专注于记录和写作的跨端 AI 笔记应用。 项目地址: https://gitcode.com/gh_mirrors/no/note-gen

1. 项目介绍

NoteGen 是一款基于 Tauri 开发的跨端 AI 笔记应用。它专注于记录、写作和利用 AI 整理笔记，旨在帮助用户更高效地捕捉、整理和创作知识。NoteGen 支持多种记录方式，如截图、文本、插图、文件等，并提供 AI 辅助的写作功能，包括问答、续写、优化、精简和翻译等。

2. 项目快速启动

环境准备

• 安装 Node.js 和 npm
• 安装 Rust，因为 Tauri 需要它来编译底层代码

克隆项目

git clone https://github.com/codexu/note-gen.git
cd note-gen

安装依赖

npm install

运行项目

运行前端

npm run dev

这将启动一个本地开发服务器，通常在 http://localhost:3000。

运行后端

tauri run

这会启动 Tauri 应用程序的后端服务。

3. 应用案例和最佳实践

记录方式

• 截图记录：适用于快速捕捉屏幕信息。
• 文本记录：复制或输入简短文本信息。
• 插图记录：自动插入到笔记中的合适位置。
• 文件记录：识别 PDF、md、html、txt 等文件内容。

写作辅助

• 版本控制：利用 Git 进行笔记的版本管理。
• AI 辅助：提供问答、续写、优化、精简、翻译等功能。

同步与图床

• 同步功能：将笔记同步到 GitHub 私有仓库，保障数据安全。
• 图床功能：支持图片上传，并转换为 Markdown 链接。

4. 典型生态项目

• Tauri：一个跨平台的应用框架，用于构建轻量级、安全的应用程序。
• Next.js：一个 React 框架，用于构建服务端渲染的 Web 应用程序。
• shadcn-ui：一套原子化的 UI 组件库。

以上是 NoteGen 的使用与启动教程，希望对您有所帮助。

note-gen 一款专注于记录和写作的跨端 AI 笔记应用。 项目地址: https://gitcode.com/gh_mirrors/no/note-gen