How mr-addict/punch-next works
值班笔记是南京工业大学科协技术开发部使用的值班记录与查阅应用。主要流程是填写笔记、由服务端校验值班时间和内容并写入 MongoDB,再按学期、搜索词和分页查阅笔记;非当前学期或不在值班期时可读取归档笔记。应用也提供学期选择、Markdown 编辑与渲染及帮助页面。归档导出和静态 JSON 的说明来自 README;未展示的客户端请求实现及归档文件位置不作推断。
Main entry points: MarkdownRenderer.tsx Markdown 渲染器 · route.ts 笔记 API · Form.tsx 笔记表单 · Header.tsx 查阅页头部
Components 26
笔记查阅
- 查阅页客户端
src/app/view/Client.tsx - 笔记列表
src/app/view/components/Body/Body.tsx - 查阅页头部
src/app/view/components/Header/Header.tsx - 笔记搜索
src/app/view/components/Header/components/Searchbar/Searchbar.tsx - 学期选择
src/app/view/components/Header/components/TermsSelector/TermsSelector.tsx - 查阅状态
src/contexts/View/ViewProvider.tsx
服务与数据
- 提交请求客户端
src/lib/api/notes/addNoteApi.ts - 笔记 API
src/app/api/notes/route.ts - Mongo 笔记库
src/lib/mongodb/notes.ts - Mongo 连接
src/lib/mongodb/clientPromise.ts - 笔记查询客户端
src/lib/api/notes/getNotesApi.ts - 学期查询客户端
src/lib/api/terms/getTermsApi.ts - 学期 API
src/app/api/terms/route.ts - 学期汇总
src/lib/notes/getAllTerms.ts - 归档笔记读取
src/lib/notes/getArchivedNotes.ts - 归档学期读取
src/lib/notes/getArchivedTerms.ts - 归档导出
src/lib/notes/archiveNotes.ts
Markdown 内容
- Markdown 编辑器
src/components/MarkdownEditor/MarkdownEditor.tsx - Markdown 渲染器
src/components/MarkdownRenderer/MarkdownRenderer.tsx - 代码块预览
src/components/MarkdownRenderer/components/Preview/Preview.tsx - 图片渲染
src/components/MarkdownRenderer/components/Img/Img.tsx - 链接渲染
src/components/MarkdownRenderer/components/Anchor/Anchor.tsx - 帮助页面
src/app/help/page.tsx
Other components
- 值班成员
Connections 28
- 值班成员 → 提交页: 打开提交
- 提交页 → 笔记表单: 显示表单
src/app/form/Client.tsx - 笔记表单 → 提交请求客户端: 提交请求
src/app/form/components/Form/Form.tsx - 笔记表单 → Markdown 编辑器: 编辑内容
src/app/form/components/Form/Form.tsx - 提交请求客户端 → 笔记 API: 发送请求
- 笔记 API → Mongo 笔记库: 查询或写入
src/app/api/notes/route.ts - Mongo 笔记库 → Mongo 连接: 获取连接
src/lib/mongodb/notes.ts - 笔记 API → 学期汇总: 校验学期
src/app/api/notes/route.ts - 笔记 API → 归档笔记读取: 读取归档
src/app/api/notes/route.ts - 学期 API → 学期汇总: 列出学期
src/app/api/terms/route.ts - 学期汇总 → 归档学期读取: 读取归档学期
src/lib/notes/getAllTerms.ts - 查阅页客户端 → 笔记列表: 显示列表
src/app/view/Client.tsx - 查阅页客户端 → 查阅页头部: 显示筛选
src/app/view/Client.tsx - 查阅页头部 → 笔记搜索: 呈现搜索
src/app/view/components/Header/Header.tsx - 查阅页头部 → 学期选择: 呈现学期选择
src/app/view/components/Header/Header.tsx - 笔记列表 → 查阅状态: 读取查阅状态
src/app/view/components/Body/Body.tsx - 查阅状态 → 笔记查询客户端: 请求笔记
src/contexts/View/ViewProvider.tsx - 查阅状态 → 学期查询客户端: 请求学期
src/contexts/View/ViewProvider.tsx - 笔记查询客户端 → 笔记 API: 请求笔记 API
- 学期查询客户端 → 学期 API: 请求学期 API
- Markdown 编辑器 → Markdown 渲染器: 预览内容
src/components/MarkdownEditor/MarkdownEditor.tsx - Markdown 渲染器 → 代码块预览: 渲染代码块
src/components/MarkdownRenderer/MarkdownRenderer.tsx - Markdown 渲染器 → 图片渲染: 渲染图片
src/components/MarkdownRenderer/MarkdownRenderer.tsx - Markdown 渲染器 → 链接渲染: 渲染链接
src/components/MarkdownRenderer/MarkdownRenderer.tsx - 代码块预览 → Markdown 渲染器: 预览 Markdown
src/components/MarkdownRenderer/components/Preview/Preview.tsx - 帮助页面 → Markdown 渲染器: 渲染帮助内容
src/app/help/page.tsx - 值班成员 → 查阅页客户端: 查阅笔记
- 归档导出 → Mongo 笔记库: 导出归档