Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/yesmore/inke

📖 A WYSIWYG notebook with AI assisted writing and real-time collaboration. Support self hosting. 一个所见即所得的Markdown笔记本，支持AI辅助写作和多人协作，支持自部署，使用IndexedDB存储笔记。
https://github.com/yesmore/inke

chatgpt editor gpt markdown nextjs notion openai-api react tailwindcss turborepo vercel

Last synced: 26 days ago
JSON representation

📖 A WYSIWYG notebook with AI assisted writing and real-time collaboration. Support self hosting. 一个所见即所得的Markdown笔记本，支持AI辅助写作和多人协作，支持自部署，使用IndexedDB存储笔记。

Host: GitHub
URL: https://github.com/yesmore/inke
Owner: yesmore
License: apache-2.0
Created: 2023-09-26T07:46:27.000Z (9 months ago)
Default Branch: web
Last Pushed: 2024-01-20T06:00:41.000Z (5 months ago)
Last Synced: 2024-02-14T07:43:26.876Z (4 months ago)
Topics: chatgpt, editor, gpt, markdown, nextjs, notion, openai-api, react, tailwindcss, turborepo, vercel
Language: TypeScript
Homepage: https://inke.app
Size: 850 KB
Stars: 483
Watchers: 1
Forks: 50
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Lists

awesome-stars - yesmore/inke - 📖 A WYSIWYG notebook with AI assisted writing and real-time collaboration. Support self hosting. 一个所见即所得的Markdown笔记本，支持AI辅助写作和多人协作，支持自部署，使用IndexedDB存储笔记。 (TypeScript)
my-awesome-stars - yesmore/inke - 📖 A WYSIWYG notebook with AI assisted writing and real-time collaboration. Support self hosting. 一个所见即所得的Markdown笔记本，支持AI辅助写作和多人协作，支持自部署，使用IndexedDB存储笔记。 (TypeScript)
awesome-stars-eryajf - yesmore/inke - 📖 A WYSIWYG notebook with AI assisted writing and real-time collaboration. Support self hosting. 一个所见即所得的Markdown笔记本，支持AI辅助写作和多人协作，支持自部署，使用IndexedDB存储笔记。 (TypeScript)
awesome-ChatGPT-repositories - inke - 📖 A WYSIWYG notebook with AI assisted writing and real-time collaboration. Support self hosting. 一个所见即所得的Markdown笔记本，支持AI辅助写作和多人协作，支持自部署，使用IndexedDB存储笔记。 (Others)
awesome-chatgpt - yesmore/inke - A browser extension that provides a WYSIWYG notebook with AI assisted writing and real-time collaboration. (UIs / Browser extensions)

README

        


  



 Inke - Small is beautiful




  

    

  

  

    

  

  



# About Inke

[Inke](https://inke.app/) is a notebook with AI assisted writing and real-time collaboration.



## 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](https://vercel.com/button)](https://vercel.com/new/clone?repository-link=https%3A%2F%2Fgithub.com%2Fyesmore%2Finke&env=OPENAI_API_KEY&envDescription=Find%20your%20OpenAI%20API%20Key%20by%20click%20the%20right%20Learn%20More%20button.%20%20&envLink=https%3A%2F%2Fplatform.openai.com%2Faccount%2Fapi-keys&project-name=inke&repository-name=inke)

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

- `BLOB_READ_WRITE_TOKEN` – your Vercel Blob read/write token (currently [still in beta](https://vercel.com/docs/storage/vercel-blob/quickstart#quickstart), but feel free to [sign up on this form](https://vercel.fyi/blob-beta) for access)

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.

To run the app locally, you can run the following commands:

```bash

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](https://vercel.com/docs/storage/vercel-blob/quickstart#quickstart) | `vercel_blob_xxxx`                                                                                                  |

| `KV_REST_API_URL`       | `string` | OPTIONAL: Vercel KV (for ratelimiting). Get your Vercel KV credentials [here](https://vercel.com/docs/storage/vercel-kv/quickstart#quickstart)           | [`"https//xxx.com"`](https://github.com/steven-tey/novel/blob/main/packages/core/src/ui/editor/default-content.tsx) |

| `KV_REST_API_TOKEN`     | `string` | OPTIONAL: Vercel KV (for ratelimiting). Get your Vercel KV credentials [here](https://vercel.com/docs/storage/vercel-kv/quickstart#quickstart).          | `abcdefg`                                                                                                           |

| `NEXTAUTH_SECRET`       | `string` | Only for production – generate one here: [generate-secret](https://generate-secret.vercel.app/32).                                                       | `fasgagahhjerherg`                                                                                                  |

| `DATABASE_URL`          | `string` | Database url, recommend using [MongoDB Atlas](https://account.mongodb.com/account/login?signedOut=true)                                                  | `mongodb+srv://xxxx`                                                                                                |

| `EMAIL_FROM`            | `string` | Next Auth Provider: [Email](https://next-auth.js.org/providers/email)                                                                                    | `Inke `                                                                                             |

| `EMAIL_SERVER`          | `string` | Next Auth Provider: [Email](https://next-auth.js.org/providers/email)                                                                                    | `smtps://xxxx`                                                                                                      |

| `GITHUB_ID`             | `string` | Next Auth Provider: [Github](https://next-auth.js.org/providers/github)                                                                                  | `aaaaaaaa`                                                                                                          |

| `GITHUB_SECRET`         | `string` | Next Auth Provider: [Github](https://next-auth.js.org/providers/github)                                                                                  | `aaaaaaaa`                                                                                                          |

| `GOOGLE_CLIENT_ID`      | `string` | Next Auth Provider: [Google](https://next-auth.js.org/providers/google)                                                                                  | `aaaaaaaa`                                                                                                          |

| `GOOGLE_CLIENT_SECRET`  | `string` | Next Auth Provider: [Google](https://next-auth.js.org/providers/google)                                                                                  | `aaaaaaaa`                                                                                                          |

# Install Inke

```bash

npm install inkejs

```

## Tech Stack

Inke 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

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=yesmore/inke&type=Date)](https://star-history.com/#yesmore/inke&Date)



  



## License

[Apache-2.0](./LICENSE) © [yesmore](https://github.com/yesmore)