{"id":18160403,"url":"https://github.com/blackishgreen33/penpal","last_synced_at":"2026-02-26T16:14:13.211Z","repository":{"id":258794533,"uuid":"868132635","full_name":"BlackishGreen33/PenPal","owner":"BlackishGreen33","description":"PenPal - 智能协作，书写未来","archived":false,"fork":false,"pushed_at":"2024-10-24T19:30:07.000Z","size":4261,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-24T21:16:11.861Z","etag":null,"topics":["liveblock","nextjs","sentry","tailwindcss"],"latest_commit_sha":null,"homepage":"https://penpal-livedocs.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BlackishGreen33.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-05T15:04:45.000Z","updated_at":"2024-10-24T19:29:25.000Z","dependencies_parsed_at":"2024-10-26T12:16:33.408Z","dependency_job_id":"c38a5e30-e755-4965-825e-6210315be2a0","html_url":"https://github.com/BlackishGreen33/PenPal","commit_stats":null,"previous_names":["blackishgreen33/penpal"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlackishGreen33%2FPenPal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlackishGreen33%2FPenPal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlackishGreen33%2FPenPal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlackishGreen33%2FPenPal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BlackishGreen33","download_url":"https://codeload.github.com/BlackishGreen33/PenPal/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247589835,"owners_count":20963022,"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":["liveblock","nextjs","sentry","tailwindcss"],"created_at":"2024-11-02T08:08:12.790Z","updated_at":"2025-11-01T04:04:21.493Z","avatar_url":"https://github.com/BlackishGreen33.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg width=\"130\" src=\"https://github.com/BlackishGreen33/PenPal/blob/main/public/assets/images/logo.png\" alt=\"PenPal Logo\"\u003e\n  \u003ch1 align=\"center\"\u003ePenPal\u003c/h1\u003e\n  \u003ch3\u003eIntelligent Collaboration, Writing the Future\u003c/h3\u003e\n  \u003ca href=\"https://github.com/BlackishGreen33/PenPal\"\u003e\u003cstrong\u003eExplore Project Documentation »\u003c/strong\u003e\u003c/a\u003e\n  \u003cbr /\u003e\n  \u003cbr /\u003e\n\n![license](https://img.shields.io/github/license/BlackishGreen33/PenPal)\n![language](https://img.shields.io/github/languages/top/BlackishGreen33/PenPal)\n![last](https://img.shields.io/github/last-commit/BlackishGreen33/PenPal)\n\n\u003ca href=\"https://penpal-livedocs.vercel.app/\" target=\"_blank\"\u003eLive Experience\u003c/a\u003e\n·\n\u003ca href=\"https://github.com/BlackishGreen33/PenPal/issues\"\u003eReport a Bug\u003c/a\u003e\n·\n\u003ca href=\"https://github.com/BlackishGreen33/PenPal/issues\"\u003eRequest a Feature\u003c/a\u003e\n\n\u003c/div\u003e\n\n## 🔖 Project Overview\n\n[中文文檔](./README-zh.md) | [README in English](./README.md)\n\n### ✨ Existing Features\n\n- Create custom team workspaces\n- Team member invitation and permission management (including `Owner`, `Administrator`, and `General Member`)\n- Create projects and assign tasks\n- Task flow and task management panel\n- Build a team document library and real-time collaborative editing\n- Use existing documents and AI intelligent retrieval Q\u0026A in the document library\n- Point system and comment system\n\n### ✒️ Technologies Used\n\n- **Development Framework**: [Next.js](https://nextjs.org/)\n- **Frontend Framework**: [React](https://react.dev/)\n- **Styling Framework**: [Tailwind CSS](https://tailwindcss.com/)\n- **Component Library**: [shadcn/ui](https://ui.shadcn.com/)\n- **State Management**: [React Query](https://tanstack.com/query/latest/docs/framework/react/overview) \u0026 [zustand](https://zustand-demo.pmnd.rs/)\n- **Text Editing**: [liveblocks](https://liveblocks.io/) \u0026 [Tiptap](https://tiptap.dev/)\n- **Backend Framework**: [Hono](https://hono.dev/)\n- **Primary Database**: [Appwrite](https://appwrite.io/)\n- **File Storage**: [uploadthing](https://uploadthing.com/)\n- **Key-Value Database**: [upstash](https://upstash.com/)\n- **Vector Database**: [upstash](https://upstash.com/)\n- **Comment System**: [giscus](https://giscus.app/)\n\n### 📋 Commit Conventions\n\n- 🎉 init: Project initialization\n- ✨ feat: New features (feature)\n- 🐞 fix: Bug fixes\n- 📃 docs: Documentation changes\n- 🌈 style: Code style changes, no logic changes\n- ✅ test: Test-related changes\n- 🔨 refactor: Code refactoring\n- 🔧 chore: Changes in build processes or auxiliary tools\n\n### 🎯 Compatible Environments\n\n- Modern browsers (Chrome \u003e= 64, Edge \u003e= 79, Firefox \u003e= 78, Safari \u003e= 12)\n- Project build environment (Node.js \u003e= 18)\n\n### 💻 Local Debugging\n\nRemember to configure environment variables first:\n\n```env\nNEXT_PUBLIC_APP_URL=\n\nNEXT_PUBLIC_APPWRITE_ENDPOINT=\nNEXT_PUBLIC_APPWRITE_PROJECT=\n\nNEXT_PUBLIC_APPWRITE_DATABASE_ID=\nNEXT_PUBLIC_APPWRITE_WORKSPACES_ID=\nNEXT_PUBLIC_APPWRITE_MEMBERS_ID=\nNEXT_PUBLIC_APPWRITE_PROJECTS_ID=\nNEXT_PUBLIC_APPWRITE_TASKS_ID=\nNEXT_PUBLIC_APPWRITE_USERS_ID=\nNEXT_PUBLIC_APPWRITE_FILES_ID=\nNEXT_PUBLIC_APPWRITE_MESSAGES_ID=\nNEXT_PUBLIC_APPWRITE_SCORES_ID=\nNEXT_PUBLIC_APPWRITE_DOCUMENTS_ID=\nNEXT_PUBLIC_APPWRITE_IMAGES_BUCKET_ID=\nNEXT_PUBLIC_APPWRITE_FILES_BUCKET_ID=\n\nNEXT_APPWRITE_KEY=\n\nUPLOADTHING_TOKEN=\n\nUPSTASH_REDIS_REST_URL=\nUPSTASH_REDIS_REST_TOKEN=\n\nUPSTASH_VECTOR_REST_URL=\nUPSTASH_VECTOR_REST_TOKEN=\n\nQSTASH_URL=\nQSTASH_TOKEN=\n\nQSTASH_CURRENT_SIGNING_KEY=\nQSTASH_NEXT_SIGNING_KEY=\n\nLIVEBLOCKS_PUBLIC_KEY=\nLIVEBLOCKS_SECRET_KEY=\n```\n\nPull the code and switch to the project directory:\n\n```bash\n$ git clone https://github.com/BlackishGreen33/PenPal.git\n$ cd PenPal\n```\n\nInstall dependencies:\n\n```bash\n$ bun install\n$ bun run dev\n```\n\nStart your debugging journey!\n\n```bash\n$ bun run dev\n```\n\n### 📝 Licensing\n\nAll the above files are licensed under the MIT License.\n\n\u003e For detailed licensing, please refer to the [LICENSE](LICENSE) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackishgreen33%2Fpenpal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblackishgreen33%2Fpenpal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackishgreen33%2Fpenpal/lists"}