PenPal

智能协作，书写未来

探索项目文档 »

在线体验 · 报告Bug · 提出新特性

🔖 项目导览

✨ 現有功能

• (待更新)

✒️ 引用技術

• 框架: Next.js
• 样式: Tailwind CSS
• (待更新)

📋 提交规范

• 🎉 init：项目初始化
• ✨ feat：新增功能（feature）
• 🐞 fix：修复bug
• 📃 docs：文档修改
• 🌈 style：代码样式修改，不影响原代码逻辑
• ✅ test：测试相关的改动
• 🔨 refactor：代码重构
• 🔧 chore：建制过程或辅助工具的变动

🎯 相容环境

• 现代浏览器（Chrome >= 64, Edge >= 79, Firefox >= 78, Safari >= 12）

💻 本地调试

记得先配置环境变量：

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=

NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up

LIVEBLOCKS_SECRET_KEY=

SENTRY_AUTH_TOKEN=

接着拉取代码和安装依赖：

$ git clone https://github.com/BlackishGreen33/PenPal.git
$ cd PenPal
$ pnpm install
$ pnpm run dev

📝 授权

上述文件皆以 MIT 许可授权

详细之授权请参考 LICENSE 文件