Skip to content
/ note Public
forked from steven-tey/novel

Notion-style WYSIWYG editor with AI-powered autocompletion.

License

Notifications You must be signed in to change notification settings

naymurdev/note

 
 

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 and whiteboard for drawings

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.

To run the app locally, you can run the following commands:

pnpm i
pnpm dev

Cross-framework support

While Novel is built for React, we also have a few community-maintained packages for non-React frameworks:

Novel is built on the following stack:

About

Notion-style WYSIWYG editor with AI-powered autocompletion.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 90.0%
  • CSS 6.9%
  • JavaScript 3.1%