模块安装与使用指南
Pocket Stack 中所有的功能都是以模块化的形式存在的。当开发者 Vibe Coding 时,基于模块的开发降低了大模型的上下文长度,节约Token,提高开发效率和成功率。
框架提供了一系列模块,包括预置的系统模块和若干应用演示模块。这些模块都是采用 Vibe Coding 的方式,在一天甚至更短时间内开发完成的。这些模块可以独立部署,也可以非常方便的集成到一个工程中。
为了保持代码库的轻量和专注,主干分支只包括必要的系统模块,应用演示模块则分布在独立的 modules/* 分支中。你可以通过切换 Git 分支来体验不同的演示模块。
可用模块
预置系统模块
预置模块详细说明见 初始化和模块管理。
| 模块名称 | 模块名 | 说明 |
|---|---|---|
| 示例页面 (Examples) | examples | 示例页面模块,包含各种示例页面,展示系统功能和组件使用方法。 |
| 系统设置 (Settings) | settings | 系统设置模块,用于配置系统全局参数。 |
| 模块管理 (Modules) | modules | 模块管理模块,用于查看和管理系统中所有模块的状态。 |
| 用户管理 (Users) | user | 用户管理模块,包含用户仪表盘和用户列表。 |
应用演示模块
| 模块名称 | 分支名 (branch) | 说明 |
|---|---|---|
| Notes (笔记) | modules/notes | 类似 Google Keep 的笔记应用,支持标签、归档、回收站。 |
| Kanban (看板) | modules/kanban | 任务管理看板,支持拖拽排序、多列状态流转。 |
| AI (对话助手) | modules/ai | 集成大模型的对话助手,支持流式响应。 |
| OKR (目标管理) | modules/okr | 目标与关键结果管理系统,支持进度追踪。 |
| NotebookLM | modules/notebooklm | 类似 Google NotebookLM 的文档问答与知识库系统。 |
应用演示模块安装
克隆项目
首先,克隆 Pocket Stack 仓库到本地:
bash
git clone https://github.com/citywill/pocket-stack.git
cd pocket-stack切换分支
使用 git checkout 命令切换到你想要体验的模块分支。
示例:切换到看板模块
bash
git checkout modules/kanban安装依赖
切换分支后,由于不同模块可能依赖不同的第三方库,建议重新安装依赖:
bash
npm install启动项目
完成上述步骤后,启动开发服务器:
bash
npm run dev访问 http://localhost:5173/ 即可体验当前模块的功能。