A Notion-style WYSYWIG editor with AI-powered autocompletions, built with Tiptap, OpenAI, and Vercel AI SDK.
https://novel.sh/docs/introduction
Novel is a Notion-style WYSIWYG editor with AI-powered autocompletions.
https://github.com/steven-tey/novel/assets/28986134/2099877f-4f2b-4b1c-8782-5d803d63be5c
You can deploy your own version of Novel to Vercel with one click:
To set up Novel locally, you'll need to clone the repository and set up the following environment variables:
OPENAI_API_KEY
– your OpenAI API key (you can get one here)BLOB_READ_WRITE_TOKEN
– your Vercel Blob read/write token (currently still in beta, but feel free to sign up on this form for access)If you've deployed this to Vercel, you can also use vc env pull
to pull the environment variables from your Vercel project.
To run the app locally, you can run the following commands:
pnpm ipnpm dev
While Novel is built for React, we also have a few community-maintained packages for non-React frameworks:
Thanks to @bennykok, Novel also has a VSCode Extension: https://novel.sh/vscode
https://github.com/steven-tey/novel/assets/28986134/58ebf7e3-cdb3-43df-878b-119e304f7373
Novel is built on the following stack:
Here's how you can contribute:
Licensed under the Apache-2.0 license.
A Notion-style WYSYWIG editor with AI-powered autocompletions, built with Tiptap, OpenAI, and Vercel AI SDK.
https://novel.sh/docs/introduction
Novel is a Notion-style WYSIWYG editor with AI-powered autocompletions.
https://github.com/steven-tey/novel/assets/28986134/2099877f-4f2b-4b1c-8782-5d803d63be5c
You can deploy your own version of Novel to Vercel with one click:
To set up Novel locally, you'll need to clone the repository and set up the following environment variables:
OPENAI_API_KEY
– your OpenAI API key (you can get one here)BLOB_READ_WRITE_TOKEN
– your Vercel Blob read/write token (currently still in beta, but feel free to sign up on this form for access)If you've deployed this to Vercel, you can also use vc env pull
to pull the environment variables from your Vercel project.
To run the app locally, you can run the following commands:
pnpm ipnpm dev
While Novel is built for React, we also have a few community-maintained packages for non-React frameworks:
Thanks to @bennykok, Novel also has a VSCode Extension: https://novel.sh/vscode
https://github.com/steven-tey/novel/assets/28986134/58ebf7e3-cdb3-43df-878b-119e304f7373
Novel is built on the following stack:
Here's how you can contribute:
Licensed under the Apache-2.0 license.