1
0
Fork 0
克隆地址:git@github.com:yesmore/inke.git (现在似乎已经无法访问了)
Go to file
songjunxi 602f2059fd release 0.3.4 2023-11-10 14:59:47 +08:00
.github chore pkg and demo 2023-10-22 10:52:46 +08:00
apps/web release 0.3.4 2023-11-10 14:59:47 +08:00
packages release 0.3.4 2023-11-10 14:59:47 +08:00
.eslintrc.json chore pkg and demo 2023-10-22 10:52:46 +08:00
.gitignore chore pkg and demo 2023-10-22 10:52:46 +08:00
LICENSE chore pkg and demo 2023-10-22 10:52:46 +08:00
README.md release 0.3.4 2023-11-10 14:59:47 +08:00
package.json release 0.3.4 2023-11-10 14:59:47 +08:00
pnpm-lock.yaml release 0.3.4 2023-11-10 14:59:47 +08:00
pnpm-workspace.yaml chore pkg and demo 2023-10-22 10:52:46 +08:00
turbo.json chore pkg and demo 2023-10-22 10:52:46 +08:00

README.md

Inke - Small is beautiful

status License inke.app's GitHub repo

About Inke

Inke is a notebook with AI assisted writing and real-time collaboration.

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

Features

  • 😗 WYSIWYG Editing like markdown
  • 😄 Efficient Shortcut Inputs
  • 😍 AI-powered Text Autocomplete
  • 🥰 Local Data Storage
  • 🥳 Image uploads(use command or drag)
  • 😍 Cloud storage notes
  • 😄 Export as json/image/markdown
  • 🥰 Install as PWA App to your desktop

Self Hosting

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

Deploy with Vercel

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

Environment Variable

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

Install Inke

npm install inkejs

Tech Stack

Inke is built on the following stack:

Star History

Star History Chart

Product Hunt

License

Apache-2.0 © yesmore