+
+
+
-
-
- 
-
-
- 
-
-
- Inke - Small is beautiful
-Inke is a Notion-style WYSIWYG editor with AI-powered autocompletions. + -See live demo: [inke-web](https://inke.app) +# About Inke + +[Inke](https://inke.app/) is a notebook with AI assisted writing and real-time collaboration.
-# Install Inke
+## Features
-```bash
-npm install inkejs
-```
+- 😗 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:
+
+[](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
@@ -42,39 +55,29 @@ pnpm build
pnpm dev
```
-Then, you can use it in your code like this:
+## Environment Variable
-```jsx
-import { Editor } from "inkejs";
+| 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 
+
+
## License
[Apache-2.0](./LICENSE) © [yesmore](https://github.com/yesmore)
diff --git a/apps/web/.env.example b/apps/web/.env.example
index a0a4414..65fdf8e 100644
--- a/apps/web/.env.example
+++ b/apps/web/.env.example
@@ -4,6 +4,7 @@
# Get your OpenAI API key here: https://platform.openai.com/account/api-keys
OPENAI_API_KEY=
+OPENAI_API_KEYs=
# OPTIONAL: Vercel Blob (for uploading images)
# Get your Vercel Blob credentials here: https://vercel.com/docs/storage/vercel-blob/quickstart#quickstart
@@ -13,3 +14,20 @@ BLOB_READ_WRITE_TOKEN=
# Get your Vercel KV credentials here: https://vercel.com/docs/storage/vercel-kv/quickstart#quickstart
KV_REST_API_URL=
KV_REST_API_TOKEN=
+
+# Only for production – generate one here: https://generate-secret.vercel.app/32
+NEXTAUTH_SECRET=
+
+## Only required for localhost
+NEXTAUTH_URL=http://localhost:3000
+
+DATABASE_URL=
+
+EMAIL_FROM=
+EMAIL_SERVER=
+
+GITHUB_ID=
+GITHUB_SECRET=
+
+GOOGLE_CLIENT_ID=
+GOOGLE_CLIENT_SECRET=
diff --git a/apps/web/.npmrc b/apps/web/.npmrc
new file mode 100644
index 0000000..b7425b9
--- /dev/null
+++ b/apps/web/.npmrc
@@ -0,0 +1 @@
+enable-pre-post-scripts=true
\ No newline at end of file
diff --git a/apps/web/app/api/auth/[...nextauth]/route.ts b/apps/web/app/api/auth/[...nextauth]/route.ts
new file mode 100644
index 0000000..b97545a
--- /dev/null
+++ b/apps/web/app/api/auth/[...nextauth]/route.ts
@@ -0,0 +1,106 @@
+import NextAuth, { NextAuthOptions, Theme } from "next-auth";
+import { PrismaAdapter } from "@next-auth/prisma-adapter";
+import prisma from "@/lib/db/prisma";
+import EmailProvider from "next-auth/providers/email";
+import GithubProvider from "next-auth/providers/github";
+import GoogleProvider from "next-auth/providers/google";
+import { createTransport } from "nodemailer";
+
+export const authOptions: NextAuthOptions = {
+ adapter: PrismaAdapter(prisma),
+ providers: [
+ GithubProvider({
+ clientId: process.env.GITHUB_ID as string,
+ clientSecret: process.env.GITHUB_SECRET as string,
+ }),
+ GoogleProvider({
+ clientId: process.env.GOOGLE_CLIENT_ID as string,
+ clientSecret: process.env.GOOGLE_CLIENT_SECRET as string,
+ }),
+ EmailProvider({
+ server: process.env.EMAIL_SERVER,
+ from: process.env.EMAIL_FROM,
+ maxAge: 10 * 60, // 10min, 邮箱链接失效时间，默认24小时
+ async sendVerificationRequest({
+ identifier: email,
+ url,
+ provider,
+ theme,
+ }) {
+ const { host } = new URL(url);
+ const transport = createTransport(provider.server);
+ const result = await transport.sendMail({
+ to: email,
+ from: provider.from,
+ subject: `You are logging in to Inke`,
+ text: text({ url, host }),
+ html: html({ url, host, theme }),
+ });
+ const failed = result.rejected.concat(result.pending).filter(Boolean);
+ if (failed.length) {
+ throw new Error(`Email(s) (${failed.join(", ")}) could not be sent`);
+ }
+ },
+ }),
+ ],
+};
+
+const handler = NextAuth(authOptions);
+
+export { handler as GET, handler as POST };
+
+/**
+ *使用HTML body 代替正文内容
+ */
+function html(params: { url: string; host: string; theme: Theme }) {
+ const { url, host, theme } = params;
+
+ const escapedHost = host.replace(/\./g, ".");
+
+ const brandColor = theme.brandColor || "#346df1";
+ const color = {
+ background: "#f9f9f9",
+ text: "#444",
+ mainBackground: "#fff",
+ buttonBackground: brandColor,
+ buttonBorder: brandColor,
+ buttonText: theme.buttonText || "#fff",
+ };
+
+ return `
+
+ | + Welcome to Inke 🎉 + | +|
+
|
+ |
| + Button click without response? Try open this link in your browser. If you did not request this email you can safely ignore it. + | +
+
+ Lightweight
+ {" "}
+ .
+ AI Powered .
+
+ Markdown
+
+
+
+ 📖 Integrate rich text, Markdown, and final render with JSON. +
++ 🎉 Continue writing, editing, translation, chat with AI, all in + one. +
++ 👨👩👦 One click to start real-time online collaboration among + multiple people. +
++ 🍥 One click simple export of PDF, images, Markdown, Json files +
+${Account_Plans[1].pay}
+${Account_Plans[2].pay}
+You are being invited to join the collaboration space
+ +