Skip to content
forked from steven-tey/novel

Notion-style WYSIWYG editor with AI-powered autocompletion.

License

Notifications You must be signed in to change notification settings

darrenhinde/novel

 
 

Repository files navigation

Novel is a Notion-style WYSIWYG editor with AI-powered autocompletions.

An open-source Notion-style WYSIWYG editor with AI-powered autocompletions.

Hacker News License Novel.sh's GitHub repo

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:

Deploy with Vercel

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 (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.

Tech Stack

Novel is built on the following stack:

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

License

Licensed under the MIT license.

About

Notion-style WYSIWYG editor with AI-powered autocompletion.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 94.3%
  • CSS 3.8%
  • JavaScript 1.9%