开源项目notesGPT的安装与使用教程

开源项目notesGPT的安装与使用教程

notesGPT Record voice notes & transcribe, summarize, and get tasks 项目地址: https://gitcode.com/gh_mirrors/no/notesGPT

1. 项目的目录结构及介绍

notesGPT项目的目录结构如下：

• app/：包含应用程序的主要逻辑和组件。
• components/：存放可复用的React组件。
• convex/：涉及Convex服务的配置和函数。
• lib/：包含一些工具函数和库。
• public/：存放静态文件，如图片、CSS文件等。
• styles/：包含项目的样式文件。
• .example.env：示例环境变量文件。
• .gitignore：指定Git应该忽略的文件和目录。
• .prettierrc：Prettier的配置文件，用于代码格式化。
• LICENSE：项目使用的许可证文件。
• README.md：项目的说明文件。
• middleware.ts：中间件配置文件。
• next.config.js：Next.js的配置文件。
• package-lock.json：Node.js依赖的锁定文件。
• package.json：项目依赖和脚本。
• postcss.config.js：PostCSS的配置文件。
• tailwind.config.ts：Tailwind CSS的配置文件。
• tsconfig.json：TypeScript的配置文件。

2. 项目的启动文件介绍

要启动此项目，首先需要安装所有依赖项：

npm install

然后，运行开发服务器：

npm run dev

在运行开发服务器后，将提示您登录到Convex并创建一个项目。接着，它会要求您提供CLERK_ISSUER_URL。为此，您需要：

• 创建一个Clerk账户。
• 复制CLERK_SECRET_KEY和NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY API密钥到.env.local文件中。
• 按照步骤1-3操作后，复制Issuer URL，格式类似于https://some-animal-123.clerk.accounts.dev。
• 将CLERK_ISSUER_URL添加到Convex环境变量中。

完成上述步骤后，前端和后端应该都在运行，您可以登录但还不能录音。

3. 项目的配置文件介绍

项目的配置文件主要包括：

• .example.env：这是一个示例环境变量文件，用于存放敏感数据，如API密钥等。在开发时，您应该创建一个.env.local文件，并将这些敏感数据放入该文件中，而不是直接放入代码库中。

• next.config.js：这是Next.js的配置文件，用于自定义Web应用的构建和运行过程。

• tailwind.config.ts：这是Tailwind CSS的配置文件，用于定义项目的样式指南。

• tsconfig.json：这是TypeScript的配置文件，用于指定TypeScript编译器的选项。

确保所有配置文件都正确设置，这对于项目的正常运行至关重要。

notesGPT Record voice notes & transcribe, summarize, and get tasks 项目地址: https://gitcode.com/gh_mirrors/no/notesGPT