Novel项目安装和配置指南
1. 项目基础介绍和主要编程语言
Novel 是一个开源的Notion风格WYSIWYG(所见即所得)编辑器,具有AI驱动的自动补全功能。该项目的主要编程语言是TypeScript,它结合了JavaScript的灵活性和静态类型检查的优势,使得代码更加健壮和易于维护。
2. 项目使用的关键技术和框架
Novel项目使用了以下关键技术和框架:
- Next.js:一个React框架,用于构建服务器端渲染和静态网站。
- Tiptap:一个基于ProseMirror的富文本编辑器,提供了丰富的编辑功能。
- OpenAI:用于AI驱动的自动补全功能。
- Vercel AI SDK:一个AI库,简化了与AI模型的集成。
- Vercel:用于项目的部署和托管。
- TailwindCSS:一个实用优先的CSS框架,用于快速构建响应式界面。
- Cal Sans:项目中使用的字体。
3. 项目安装和配置的准备工作和详细安装步骤
准备工作
在开始安装之前,请确保你的开发环境满足以下要求:
- Node.js:建议使用最新版本的Node.js(推荐v16.x或更高版本)。
- pnpm:项目使用pnpm作为包管理器,确保你已经安装了pnpm。
- OpenAI API Key:你需要一个OpenAI API Key来启用AI功能。
- Vercel Blob Read/Write Token:用于存储和读取数据,目前仍处于测试阶段,但你可以通过填写此表单申请访问。
详细安装步骤
-
克隆项目仓库
首先,克隆Novel项目的GitHub仓库到你的本地机器:
git clone https://github.com/steven-tey/novel.git cd novel
-
安装依赖
使用pnpm安装项目依赖:
pnpm install
-
配置环境变量
在项目根目录下创建一个
.env
文件,并添加以下环境变量:OPENAI_API_KEY=your_openai_api_key BLOB_READ_WRITE_TOKEN=your_vercel_blob_token
将
your_openai_api_key
替换为你的OpenAI API Key,将your_vercel_blob_token
替换为你的Vercel Blob Read/Write Token。 -
启动开发服务器
运行以下命令启动开发服务器:
pnpm dev
服务器启动后,你可以在浏览器中访问
http://localhost:3000
来查看和使用Novel编辑器。 -
构建和部署
如果你想将项目部署到Vercel,可以使用以下命令进行构建:
pnpm build
然后,使用Vercel CLI进行部署:
vercel
按照提示完成部署过程。
通过以上步骤,你已经成功安装并配置了Novel项目。现在你可以开始使用这个强大的AI驱动的编辑器来创建和编辑内容了!
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考