luchenqun / inke

A markdown-like web editor with AI-powered, store data locally.

Inke

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

Introduction

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

Self Hosting

You can deploy your own version of Inke to Vercel with one click:

Setting Up Locally

To set up Inke 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)
• BLOB_READ_WRITE_TOKEN – your Vercel Blob read/write token (currently still in beta, but feel free to sign up on this form for access)

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 build
pnpm dev

# Sync
git fetch upstream
git merge upstream/main
git push origin main

Tech Stack

Inke is built on the following stack:

• Next.js – framework
• Tiptap – text editor
• OpenAI - AI completions
• Vercel AI SDK – AI library
• Vercel – deployments
• TailwindCSS – styles

License

GPL © yesmore

Star History