{"id":13406006,"url":"https://github.com/steven-tey/novel","last_synced_at":"2025-05-12T16:33:29.726Z","repository":{"id":175894536,"uuid":"617179274","full_name":"steven-tey/novel","owner":"steven-tey","description":"Notion-style WYSIWYG editor with AI-powered autocompletion.","archived":false,"fork":false,"pushed_at":"2025-01-18T14:26:33.000Z","size":92713,"stargazers_count":14562,"open_issues_count":107,"forks_count":1197,"subscribers_count":47,"default_branch":"main","last_synced_at":"2025-05-05T14:53:57.775Z","etag":null,"topics":["ai-sdk","chatgpt","nextjs","notion","openai","prosemirror","tiptap","vercel"],"latest_commit_sha":null,"homepage":"https://novel.sh","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/steven-tey.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"andrewdoro"}},"created_at":"2023-03-21T21:14:33.000Z","updated_at":"2025-05-05T13:53:00.000Z","dependencies_parsed_at":"2023-09-27T00:32:06.465Z","dependency_job_id":"8d7e716a-7940-429d-adb3-fc0575c4df8b","html_url":"https://github.com/steven-tey/novel","commit_stats":{"total_commits":471,"total_committers":49,"mean_commits":9.612244897959183,"dds":0.5520169851380042,"last_synced_commit":"ecdb5d2ff5d3e6ab5f5af95b5a81de3ab4e8a0e9"},"previous_names":["steven-tey/novel"],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steven-tey%2Fnovel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steven-tey%2Fnovel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steven-tey%2Fnovel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steven-tey%2Fnovel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/steven-tey","download_url":"https://codeload.github.com/steven-tey/novel/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253561094,"owners_count":21927762,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai-sdk","chatgpt","nextjs","notion","openai","prosemirror","tiptap","vercel"],"created_at":"2024-07-30T19:02:18.428Z","updated_at":"2025-05-12T16:33:29.701Z","avatar_url":"https://github.com/steven-tey.png","language":"TypeScript","funding_links":["https://github.com/sponsors/andrewdoro"],"categories":["TypeScript","Openai","SDK, Libraries, Frameworks","Project List","A01_文本生成_文本对话","HarmonyOS","Apps","Libs and Components","Components","Repos","Components \u0026 Libraries","chatgpt","Editors"],"sub_categories":["JavaScript/Typescript library, sdk or frameworks","\u003cspan id=\"tool\"\u003eLLM (LLM \u0026 Tool)\u003c/span\u003e","大语言对话模型及数据","Windows Manager","Writing"],"readme":"\u003ca href=\"https://novel.sh\"\u003e\n  \u003cimg alt=\"Novel is a Notion-style WYSIWYG editor with AI-powered autocompletions.\" src=\"https://novel.sh/opengraph-image.png\"\u003e\n  \u003ch1 align=\"center\"\u003eNovel\u003c/h1\u003e\n\u003c/a\u003e\n\n\u003cp align=\"center\"\u003e\n  An open-source Notion-style WYSIWYG editor with AI-powered autocompletions. \n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://news.ycombinator.com/item?id=36360789\"\u003e\u003cimg src=\"https://img.shields.io/badge/Hacker%20News-369-%23FF6600\" alt=\"Hacker News\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/steven-tey/novel/blob/main/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/steven-tey/novel?label=license\u0026logo=github\u0026color=f80\u0026logoColor=fff\" alt=\"License\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/steven-tey/novel\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/steven-tey/novel?style=social\" alt=\"Novel.sh's GitHub repo\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#introduction\"\u003e\u003cstrong\u003eIntroduction\u003c/strong\u003e\u003c/a\u003e ·\n  \u003ca href=\"#deploy-your-own\"\u003e\u003cstrong\u003eDeploy Your Own\u003c/strong\u003e\u003c/a\u003e ·\n  \u003ca href=\"#setting-up-locally\"\u003e\u003cstrong\u003eSetting Up Locally\u003c/strong\u003e\u003c/a\u003e ·\n  \u003ca href=\"#tech-stack\"\u003e\u003cstrong\u003eTech Stack\u003c/strong\u003e\u003c/a\u003e ·\n  \u003ca href=\"#contributing\"\u003e\u003cstrong\u003eContributing\u003c/strong\u003e\u003c/a\u003e ·\n  \u003ca href=\"#license\"\u003e\u003cstrong\u003eLicense\u003c/strong\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cbr/\u003e\n\n## Docs (WIP)\n\nhttps://novel.sh/docs/introduction\n\n## Introduction\n\n[Novel](https://novel.sh/) is a Notion-style WYSIWYG editor with AI-powered autocompletions.\n\nhttps://github.com/steven-tey/novel/assets/28986134/2099877f-4f2b-4b1c-8782-5d803d63be5c\n\n\u003cbr /\u003e\n\n## Deploy Your Own\n\nYou can deploy your own version of Novel to Vercel with one click:\n\n[![Deploy with Vercel](https://vercel.com/button)](https://stey.me/novel-deploy)\n\n## Setting Up Locally\n\nTo set up Novel locally, you'll need to clone the repository and set up the following environment variables:\n\n- `OPENAI_API_KEY` – your OpenAI API key (you can get one [here](https://platform.openai.com/account/api-keys))\n- `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)\n\nIf 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.\n\nTo run the app locally, you can run the following commands:\n\n```\npnpm i\npnpm dev\n```\n\n## Cross-framework support\n\nWhile Novel is built for React, we also have a few community-maintained packages for non-React frameworks:\n\n- Svelte: https://novel.sh/svelte\n- Vue: https://novel.sh/vue\n\n## VSCode Extension\n\nThanks to @bennykok, Novel also has a VSCode Extension: https://novel.sh/vscode\n\nhttps://github.com/steven-tey/novel/assets/28986134/58ebf7e3-cdb3-43df-878b-119e304f7373\n\n## Tech Stack\n\nNovel is built on the following stack:\n\n- [Next.js](https://nextjs.org/) – framework\n- [Tiptap](https://tiptap.dev/) – text editor\n- [OpenAI](https://openai.com/) - AI completions\n- [Vercel AI SDK](https://sdk.vercel.ai/docs) – AI library\n- [Vercel](https://vercel.com) – deployments\n- [TailwindCSS](https://tailwindcss.com/) – styles\n- [Cal Sans](https://github.com/calcom/font) – font\n\n## Contributing\n\nHere's how you can contribute:\n\n- [Open an issue](https://github.com/steven-tey/novel/issues) if you believe you've encountered a bug.\n- Make a [pull request](https://github.com/steven-tey/novel/pull) to add new features/make quality-of-life improvements/fix bugs.\n\n\u003ca href=\"https://github.com/steven-tey/novel/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=steven-tey/novel\" /\u003e\n\u003c/a\u003e\n\n## Repo Activity\n\n![Novel.sh repo activity – generated by Axiom](https://repobeats.axiom.co/api/embed/2ebdaa143b0ad6e7c2ee23151da7b37f67da0b36.svg)\n\n## License\n\nLicensed under the [Apache-2.0 license](https://github.com/steven-tey/novel/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteven-tey%2Fnovel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsteven-tey%2Fnovel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteven-tey%2Fnovel/lists"}