Novel
An open-source Notion-style WYSIWYG editor with AI-powered autocompletions.
Introduction · Deploy Your Own · Setting Up Locally · Tech Stack · Contributing · License
Introduction
Novel is a Notion-style WYSIWYG editor with AI-powered autocompletions.
Here's a quick 30-second demo:
Novel.mp4
Deploy Your Own
You can deploy your own version of Novel to Vercel with one click:
Setting Up Locally
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 (you can get one here)
If you've deployed this to Vercel, you can also use vc env pull to pull the environment variables from your Vercel project.
Tech Stack
Novel is built on the following stack:
- Next.js – framework
- Tiptap – text editor
- OpenAI - AI completions
- Vercel AI SDK – AI library
- Vercel – deployments
- TailwindCSS – styles
- Cal Sans – font
Contributing
Here's how you can contribute:
- Open an issue if you believe you've encountered a bug.
- Make a pull request to add new features/make quality-of-life improvements/fix bugs.
Author
- Steven Tey (@steventey)
License
Licensed under the MIT license.