novel README

The project's README from github.com/steven-tey/novel. As one markdown file: README.md.

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

Novel

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


Docs (WIP)

https://novel.sh/docs/introduction

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


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:

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:

VSCode Extension

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

Tech Stack

Novel is built on the following stack:

Contributing

Here's how you can contribute:

Repo Activity

Novel.sh repo activity – generated by Axiom

License

Licensed under the Apache-2.0 license.

novel (steven-tey/novel)

wysiwyg
Searching Database…

16.4K ·GitHub
What is this?Novel is an open-source, Notion-style WYSIWYG editor with AI-powered autocompletions — a writing surface that looks like Notion and finishes your sentences with AI.
Is this a hosted service I sign up for, or something I run myself?Something you run yourself: it is an open-source web app you can deploy to your own Vercel account in one click, or run locally while developing.
How do I get it running locally?Clone the repo, set two environment variables — OPENAI_API_KEY and BLOB_READ_WRITE_TOKEN — then start the dev server. Already deployed to Vercel? vc env pull copies the variables from your project.
Do I need my own API keys for that?Yes: your own OpenAI API key powers the completions, plus a Vercel Blob read/write token, which is still in beta and requires signing up on a form for access.
Is anything still rough around the edges?A couple of things: the Vercel Blob storage integration is in beta, and the documentation is marked as work-in-progress.
Does it connect to my Notion workspace?No — 'Notion-style' only describes the editor's look and feel. The README mentions no Notion integration; it is an independent editor you deploy yourself.
Is there a VSCode extension?Yes — a community-maintained VSCode extension by bennykok brings Novel-style editing into VS Code, separate from the web app.
Creator
steven-tey
Size
90.5 MB
Stars
16.4K
Age
3y
Commits · 90 Days