novel

Роман

Редактор Wysiwyg в стиле с открытым исходным кодом с автозаполнением AI с автоматическими заполнениями.

Введение · Развернуть свое собственное · настройка локально · Технический стек · Внесение · Лицензия

Документы (WIP)

https://novel.sh/docs/introduction

Введение

Роман-это редактор Wysiwyg в стиле понятия с автозаполнением AI.

Роман.mp4

Развернуть свое

Вы можете развернуть свою собственную версию романа в Vercel с одним щелчком:

Настройка локально

Чтобы настроить новый локальный, вам нужно клонировать репозиторий и настроить следующие переменные среды:

• OPENAI_API_KEY - ваш ключ API Openai (вы можете получить его здесь)
• BLOB_READ_WRITE_TOKEN - ваш токен Blob Blob Blob (в настоящее время все еще в бета -версии, но не стесняйтесь зарегистрироваться в этой форме для доступа)

Если вы развернули это в Vercel, вы также можете использовать vc env pull , чтобы вытащить переменные среды из вашего проекта Vercel.

Чтобы запустить приложение локально, вы можете запустить следующие команды:

 pnpm i
pnpm dev

Поддержка перекрестной работы

Хотя роман построен для React, у нас также есть несколько пакетов, обслуживаемых сообществом для нереактивных рамок:

• СВЕЛТ: https://novel.sh/svelte
• Vue: https://novel.sh/vue

Расширение VSCODE

Спасибо @bennykok, у рома также есть расширение VSCODE: https://novel.sh/vscode

CleanShot.2023-09-02.at.09.36.03.mp4

Технический стек

Роман построен на следующем стеке:

• Next.js - Framework
• Tiptap - текстовый редактор
• OpenAI - AI завершение
• Vercel AI SDK - библиотека AI
• Vercel - развертывание
• Tailwindcss - стили
• Кэл Санс - шрифт

Внося

Вот как вы можете внести свой вклад:

• Откройте проблему, если вы считаете, что столкнулись с ошибкой.
• Сделайте запрос на привлечение, чтобы добавить новые функции/сделать улучшения качества жизни/исправить ошибки.

Репо

Лицензия

Лицензирован по лицензии Apache-2.0.