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)

Searching Database…

16.4K ·GitHub
Что это такое?Novel — это open-source редактор в стиле Notion с WYSIWYG-разметкой и автодополнением на базе ИИ: текстовая среда, которая выглядит как Notion и дописывает ваши предложения с помощью ИИ.
Это сервис, в котором нужно регистрироваться, или я запускаю его сам?Вы запускаете его сами: это open-source веб-приложение, которое можно в один клик развернуть в своём аккаунте Vercel или запустить локально во время разработки.
Как запустить его у себя локально?Склонируйте репозиторий, задайте две переменные окружения — OPENAI_API_KEY и BLOB_READ_WRITE_TOKEN — и запустите dev-сервер. Уже развернули проект на Vercel? Команда vc env pull скопирует переменные из вашего проекта.
Для этого нужны мои собственные API-ключи?Да: автодополнение работает на вашем собственном ключе OpenAI API, плюс нужен токен на чтение и запись для Vercel Blob — он пока в бета-версии, и доступ к нему выдаётся по заявке через форму.
Есть ли ещё что-то сырое, недоработанное?Пара моментов: интеграция с хранилищем Vercel Blob находится в бета-версии, а документация помечена как находящаяся в процессе написания.
Он подключается к моему рабочему пространству Notion?Нет — «в стиле Notion» описывает только внешний вид и поведение редактора. В README ни о какой интеграции с Notion не упоминается: это независимый редактор, который вы разворачиваете сами.
Есть ли расширение для VSCode?Да — поддерживаемое сообществом расширение для VSCode от bennykok приносит редактирование в стиле Novel в VS Code; оно существует отдельно от веб-приложения.
Creator
steven-tey
Size
90.5 MB
Stars
16.4K
Age
3y
Commits · 90 Days