Introduction to Novel
Novel is an innovative a Notion-style WYSIWYG (What You See Is What You Get) editor that stands out with its AI-powered autocompletions. It offers an open-source solution where users can easily format their text while benefiting from intelligent suggestions that enhance the writing process. Ideal for users who appreciate the simplicity of apps like Notion but crave more advanced features, Novel combines ease of use with cutting-edge technology.
Deploy Your Own Version
For those interested in customizing and deploying their own instance of Novel, the process is straightforward. Novel can be hosted on Vercel with just a single click, making it accessible for both individuals and organizations looking to leverage its functionalities on their own servers. This ease of deployment ensures that users can quickly start utilizing Novel without extensive technical know-how.
Setting Up Locally
Setting up Novel on a local environment requires a few simple steps. Users need to clone the project's repository and configure some environment variables. Essential among these are the OPENAI_API_KEY, which users can obtain from OpenAI, and the BLOB_READ_WRITE_TOKEN, which can be requested from Vercel as part of their beta program. For those who have already deployed Novel to Vercel, there's an option to pull environment variables directly from their Vercel project using the vc env pull command. Running the application locally is a breeze with the following commands:
pnpm i
pnpm dev
Cross-Framework Support
While Novel is originally built for React, it embraces versatility with community-maintained packages for other frameworks, ensuring broad usability across different developer preferences. These packages currently support popular frameworks like Svelte and Vue, expanding Novel's reach beyond its React roots.
VSCode Extension
In collaboration with @bennykok, Novel extends its functionality into development environments through a dedicated VSCode Extension. This extension brings the robust capabilities of Novel directly into the VSCode IDE, allowing for seamless integration and productivity boosts within the developer's workflow.
Tech Stack
The development of Novel rests on a robust stack of technologies:
- Next.js: A React-based framework that supports server-side rendering and static websites.
- Tiptap: A rich-text editor of choice for Novel, ensuring a smooth user experience.
- OpenAI: Provides the AI-completion capabilities that make Novel intelligent and intuitive.
- Vercel AI SDK: An integral part of harnessing AI-powered functionalities.
- Vercel: The deployment platform ensuring fast and reliable hosting.
- TailwindCSS: Enables developers to style applications efficiently.
- Cal Sans: The font of choice, ensuring readability and aesthetic appeal.
Contributing
Novel thrives on community engagement and contributions. Users can contribute by reporting issues or bugs through the GitHub repository and can also make enhancements or fix bugs by submitting pull requests. This collaborative approach invites the input of global developers to enhance and expand Novel's capabilities continually.
License
Novel is released under the Apache-2.0 license, a permissive license that allows users to freely use, modify, and distribute the software, ensuring it remains a valuable community asset.
In summary, Novel provides a unique blend of ease and technology, inviting users into an enhanced writing and editing experience powered by AI. Whether using it for personal projects or deploying it at scale, Novel offers the tools necessary for efficient content creation.