https://github.com/hasparus/novel

Notion-style WYSIWYG editor with AI-powered autocompletions
https://github.com/hasparus/novel

Last synced: 11 months ago
JSON representation

Notion-style WYSIWYG editor with AI-powered autocompletions

• Host: GitHub
• URL: https://github.com/hasparus/novel
• Owner: hasparus
• License: mit
• Fork: true (steven-tey/novel)
• Created: 2023-06-19T06:11:17.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-06-26T09:25:45.000Z (almost 3 years ago)
• Last Synced: 2024-12-06T17:22:16.345Z (over 1 year ago)
• Language: TypeScript
• Homepage: https://novel.sh
• Size: 586 KB
• Stars: 59
• Watchers: 1
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  

  
Novel






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





  

  

    

  

  





  Introduction ·

  Deploy Your Own ·

  Setting Up Locally ·

  Tech Stack ·

  Contributing ·

  License






## Introduction

[Novel](https://novel.sh/) is a Notion-style WYSIWYG editor with AI-powered autocompletions.

Here's a quick 30-second demo:

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](https://vercel.com/button)](https://stey.me/novel-deploy)

## 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](https://platform.openai.com/account/api-keys))

- `BLOB_READ_WRITE_TOKEN` – your Vercel Blob read/write token (you can get one [here](https://vercel.com/docs/storage/vercel-blob/quickstart#quickstart))

If you've deployed this to Vercel, you can also use [`vc env pull`](https://vercel.com/docs/cli/env#exporting-development-environment-variables) to pull the environment variables from your Vercel project.

## Tech Stack

Novel is built on the following stack:

- [Next.js](https://nextjs.org/) – framework

- [Tiptap](https://tiptap.dev/) – text editor

- [OpenAI](https://openai.com/) - AI completions

- [Vercel AI SDK](https://sdk.vercel.ai/docs) – AI library

- [Vercel](https://vercel.com) – deployments

- [TailwindCSS](https://tailwindcss.com/) – styles

- [Cal Sans](https://github.com/calcom/font) – font

## Contributing

Here's how you can contribute:

- [Open an issue](https://github.com/steven-tey/novel/issues) if you believe you've encountered a bug.

- Make a [pull request](https://github.com/steven-tey/novel/pull) to add new features/make quality-of-life improvements/fix bugs.

## Author

- Steven Tey ([@steventey](https://twitter.com/steventey))

## License

Licensed under the [MIT license](https://github.com/steven-tey/novel/blob/main/LICENSE.md).