delilahsaturn/pepperminto-knowledge-base

Pepperminto 🍵

Pepperminto是一款现代化、社区驱动的工单管理系统与知识库，它是Peppermint的现代化分支，以高性能单仓库形式重构，专注于开发者体验与优质用户界面。

🏗️ 传承与致谢

Pepperminto基于优秀的开源项目构建，我们向原作者致以诚挚感谢：

• Peppermint.sh：原始灵感与代码库，访问peppermint.sh或其https://github.com/Peppermint-Lab/peppermint%E3%80%82
• nulldoubt/pepperminto：该分支的关键迭代版本，为当前仓库奠定基础。https://github.com/nulldoubt/pepperminto%E3%80%82

✨ 核心功能与改进

Pepperminto通过现代工具与增强功能优化了原始概念：

🎨 现代化管理体验

!管理面板

• 基于shadcn/ui重构：采用现代设计模式的全新界面。
• 深色模式支持：整个仪表盘与知识库原生支持深色模式。
• 响应式设计：在桌面、平板与移动设备上均可流畅使用。

📚 公共知识库

!知识库

• SEO优化：专为文章与文档设计的面向公众站点。
• 管理员CRUD工作流：直接从仪表盘创建、编辑与组织知识库文章。
• 自定义Slug：用户友好的URL，提升可发现性与SEO效果。

📝 精准编辑

• BlockNote集成：类Notion的富文本编辑体验。
• 一致性：工单、内部文档与知识库使用相同的强大编辑器。

🛠️ 核心能力

• 工单管理：支持支持请求的全生命周期管理。
• IMAP集成：自动获取并处理邮件为工单。
• 时间跟踪：记录与管理各任务的耗时。
• Webhooks与存储：可扩展架构，支持Webhook与灵活的对象存储。
• 基于角色的访问：对用户权限与角色的细粒度控制。

⚙️ 开发者优先架构

• Turborepo + pnpm：闪电般的构建速度与高效的工作区管理。
• 清晰的单仓库：按apps/api、apps/client、apps/knowledge-base分离关注点。
• Fastify后端：高性能、 schema驱动的API，带有自动Swagger文档。

📦 单仓库布局

• apps/api – 基于Prisma ORM的Fastify API服务器。
• apps/client – 管理仪表盘与工单管理（Next.js）。
• apps/knowledge-base – SEO友好的公共文档站点（Next.js）。

🚀 快速开始

本地开发

1. 安装依赖：

   bash
   pnpm install
   

2. 设置环境： 将.env.example复制为.env，并配置数据库与API设置。

3. 启动开发：

   bash
   pnpm dev
   

默认凭据

全新安装后，可使用以下凭据登录：

• *******：admin@admin.com
• 密码：1234

[!IMPORTANT] 首次登录后请立即修改这些凭据。

🐳 Docker部署

运行Pepperminto最简单的方式是通过Docker Compose：

bash
cp .env.example .env
docker compose build
docker compose up -d

🔗 项目链接

• 主仓库：https://github.com/DelilahSaturn/pepperminto-enhanced
• 原始项目：Peppermint.sh
• 祖先分支：https://github.com/nulldoubt/pepperminto

⚖️ 许可证

Pepperminto采用GNU Affero通用公共许可证（AGPLv3）授权。详见LICENSE文件。