Overview

Novel is a Notion-style WYSIWYG editor with AI-powered autocompletions. Users can deploy their own version of Novel to Vercel with a single click or set it up locally by cloning the repository and setting up the required environment variables.

Features

• AI-powered Autocompletions: Novel provides AI-powered autocompletions for enhanced writing experiences.
• Deploy with Vercel: Easily deploy Novel to Vercel with a one-click deployment option.
• Cross-framework Support: Apart from React, Novel offers support for Svelte, Vue, and a VSCode Extension.
• Tech Stack: Built on Next.js, Tiptap, OpenAI, Vercel AI SDK, Vercel, TailwindCSS, and Cal Sans font.
• Contributing Guidelines: Users can contribute by opening issues for bugs, making pull requests, or enhancing features.

Installation

To set up Novel locally, follow these steps:

1. Clone the repository.
2. Set up the following environment variables:
   • OPENAI_API_KEY – your OpenAI API key.
   • BLOB_READ_WRITE_TOKEN – your Vercel Blob read/write token.
3. Run vc env pull if you have deployed to Vercel to pull the environment variables.
4. Run the app locally by executing the necessary commands.

Summary

Novel is a versatile WYSIWYG editor that integrates AI capabilities for autocompletions, making it user-friendly for a seamless writing experience. With easy deployment options on Vercel, cross-framework support, and a collaborative contribution process, Novel caters to a wide range of users looking for an advanced writing tool.