PenPal

Intelligent Collaboration, Writing the Future

Explore Project Documentation »

Live Experience · Report a Bug · Request a Feature

🔖 Project Overview

中文文檔 | README in English

✨ Existing Features

• Create custom team workspaces
• Team member invitation and permission management (including Owner, Administrator, and General Member)
• Create projects and assign tasks
• Task flow and task management panel
• Build a team document library and real-time collaborative editing
• Use existing documents and AI intelligent retrieval Q&A in the document library
• Point system and comment system

✒️ Technologies Used

• Development Framework: Next.js
• Frontend Framework: React
• Styling Framework: Tailwind CSS
• Component Library: shadcn/ui
• State Management: React Query & zustand
• Text Editing: liveblocks & Tiptap
• Backend Framework: Hono
• Primary Database: Appwrite
• File Storage: uploadthing
• Key-Value Database: upstash
• Vector Database: upstash
• Comment System: giscus

📋 Commit Conventions

• 🎉 init: Project initialization
• ✨ feat: New features (feature)
• 🐞 fix: Bug fixes
• 📃 docs: Documentation changes
• 🌈 style: Code style changes, no logic changes
• ✅ test: Test-related changes
• 🔨 refactor: Code refactoring
• 🔧 chore: Changes in build processes or auxiliary tools

🎯 Compatible Environments

• Modern browsers (Chrome >= 64, Edge >= 79, Firefox >= 78, Safari >= 12)
• Project build environment (Node.js >= 18)

💻 Local Debugging

Remember to configure environment variables first:

NEXT_PUBLIC_APP_URL=

NEXT_PUBLIC_APPWRITE_ENDPOINT=
NEXT_PUBLIC_APPWRITE_PROJECT=

NEXT_PUBLIC_APPWRITE_DATABASE_ID=
NEXT_PUBLIC_APPWRITE_WORKSPACES_ID=
NEXT_PUBLIC_APPWRITE_MEMBERS_ID=
NEXT_PUBLIC_APPWRITE_PROJECTS_ID=
NEXT_PUBLIC_APPWRITE_TASKS_ID=
NEXT_PUBLIC_APPWRITE_USERS_ID=
NEXT_PUBLIC_APPWRITE_FILES_ID=
NEXT_PUBLIC_APPWRITE_MESSAGES_ID=
NEXT_PUBLIC_APPWRITE_SCORES_ID=
NEXT_PUBLIC_APPWRITE_DOCUMENTS_ID=
NEXT_PUBLIC_APPWRITE_IMAGES_BUCKET_ID=
NEXT_PUBLIC_APPWRITE_FILES_BUCKET_ID=

NEXT_APPWRITE_KEY=

UPLOADTHING_TOKEN=

UPSTASH_REDIS_REST_URL=
UPSTASH_REDIS_REST_TOKEN=

UPSTASH_VECTOR_REST_URL=
UPSTASH_VECTOR_REST_TOKEN=

QSTASH_URL=
QSTASH_TOKEN=

QSTASH_CURRENT_SIGNING_KEY=
QSTASH_NEXT_SIGNING_KEY=

LIVEBLOCKS_PUBLIC_KEY=
LIVEBLOCKS_SECRET_KEY=

Pull the code and switch to the project directory:

$ git clone https://github.com/BlackishGreen33/PenPal.git
$ cd PenPal

Install dependencies:

$ bun install
$ bun run dev

Start your debugging journey!

$ bun run dev

📝 Licensing

All the above files are licensed under the MIT License.

For detailed licensing, please refer to the LICENSE file.