NoteGen 安装与配置指南

NoteGen 安装与配置指南

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

1. 项目基础介绍

NoteGen 是一款专注于记录和写作的跨端 AI 笔记应用。它基于 Tauri 开发，旨在将记录、写作和 AI 结合使用，帮助用户快速捕捉和整理碎片化知识。

主要编程语言：TypeScript

2. 项目使用的关键技术和框架

• Tauri 2: 跨平台桌面应用框架
• Next.js 15: 用于构建服务端渲染和静态站点生成应用的 React 框架
• shadcn-ui: 用于构建美观、响应式用户界面的组件库
• Tailwind CSS: 功能类优先的 CSS 框架
• OpenAI 协议模型: 如 ChatGPT、ChatAnyWhere 等 AI 模型

3. 项目安装和配置的准备工作

在开始安装和配置 NoteGen 项目之前，请确保您的系统已经安装以下软件：

• Node.js (推荐使用 LTS 版本)
• Git

安装完成后，请执行以下命令检查版本：

node -v
git -v

确保版本符合要求后，即可进行下一步。

3.1 克隆项目

首先，您需要克隆项目到本地：

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

3.2 安装依赖

进入项目目录后，执行以下命令安装项目依赖：

npm install

3.3 配置环境变量

根据您的开发环境，您可能需要配置环境变量。创建一个 .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 地址和密钥。

3.4 运行项目

安装和配置完成后，您可以通过以下命令启动项目：

npm run dev

项目将在本地开发环境中启动，通常默认端口为 3000。您可以通过浏览器访问 http://localhost:3000 查看项目。

以上便是 NoteGen 的安装和配置指南，按照上述步骤操作后，您应该能够成功运行该项目。

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