About Inke

Inke - Small is beautiful

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

Features

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

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

Prop	Type	Description	Example
`OPENAI_API_KEY`	`string`	The API Key to use for the OpenAI completion API.	`sk-xxx`
`BLOB_READ_WRITE_TOKEN`	`string`	OPTIONAL: Vercel Blob (for uploading images). Get your Vercel Blob credentials here	`vercel_blob_xxxx`
`KV_REST_API_URL`	`string`	OPTIONAL: Vercel KV (for ratelimiting). Get your Vercel KV credentials here	`"https//xxx.com"`
`KV_REST_API_TOKEN`	`string`	OPTIONAL: Vercel KV (for ratelimiting). Get your Vercel KV credentials here.	`abcdefg`
`NEXTAUTH_SECRET`	`string`	Only for production – generate one here: generate-secret.	`fasgagahhjerherg`
`DATABASE_URL`	`string`	Database url, recommend using MongoDB Atlas	`mongodb+srv://xxxx`
`EMAIL_FROM`	`string`	Next Auth Provider: Email	`Inke <email@inke.app>`
`EMAIL_SERVER`	`string`	Next Auth Provider: Email	`smtps://xxxx`
`GITHUB_ID`	`string`	Next Auth Provider: Github	`aaaaaaaa`
`GITHUB_SECRET`	`string`	Next Auth Provider: Github	`aaaaaaaa`
`GOOGLE_CLIENT_ID`	`string`	Next Auth Provider: Google	`aaaaaaaa`
`GOOGLE_CLIENT_SECRET`	`string`	Next Auth Provider: Google	`aaaaaaaa`

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

Inke is built on the following stack:

Name		Name	Last commit message	Last commit date
Latest commit History 231 Commits
.github		.github
apps/web		apps/web
packages		packages
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
.gitpod.yml		.gitpod.yml
LICENSE		LICENSE
README.md		README.md
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
pnpm-workspace.yaml		pnpm-workspace.yaml
turbo.json		turbo.json