基础上传

railsxiaojiang · Oct 26, 2023 · 1afa981 · 1afa981
1 parent 0d0d1e5
commit 1afa981
Show file tree

Hide file tree

Showing 5 changed files with 250 additions and 17 deletions.
diff --git a/.vitepress/config.ts b/.vitepress/config.ts
@@ -26,23 +26,7 @@ export default defineConfig({
       { text: '产品日志', link: '/guide/why-electron-vite' },
     ],
     sidebar: [
-      // {
-      //   text: '解决方案',
-      //   collapsed: false,
-      //   items: [
-      //     { text: '多国语家校互通', link: '/client/index' },
-      //     { text: '学生评估', link: '/client/driver' },
-      //     { text: '作业管理', link: '/client/index' },
-      //     { text: '通知回执', link: '/client/conversation' },
-      //     { text: '校车服务', link: '/client/chatroom' },
-      //     { text: '课后班报名', link: '/client/chat-setting' },
-      //     { text: '校餐管理', link: '/client/driver' },
-      //     { text: '校友圈管理', link: '/client/driver' },
-      //     { text: '办公OA', link: '/client/driver' },
-
-
-      //   ],
-      // },
+
       {
         text: '客户端说明',
         collapsed: false,
@@ -63,9 +47,20 @@ export default defineConfig({
         collapsed: false,
         items: [
           { text: '---后台模块规划---', link: '/admin/index' },
+          { text: 'Member 学生 老师', link: '/admin/member' },
+
         ],
       },
 
+            {
+        text: '接口字段',
+        collapsed: false,
+        items: [
+          { text: '1.用户，档案，公司体系', link: '/json_rules/user' },
+          { text: '2.聊天体系', link: '/json_rules/chat' },
+
+        ],
+      },
 
       {
         text: '后端架构',

diff --git a/admin/member.md b/admin/member.md
@@ -0,0 +1,15 @@
+# 学生/老师字段管理
+
+## 学生管理
+
+### 学生报表
+
+### 申请生列表
+1. 系统编号
+2. 学号可能为空 不显示
+3. 性别
+4. 状态
+5. 年龄
+6. 标签
+7. 是否允许登录
+
diff --git a/json_rules/chat.md b/json_rules/chat.md
@@ -0,0 +1,57 @@
+# 聊天相关数据
+
+## 会话管理
+
+```json
+  {
+            "id": 1,
+            "chat_room_id": 1, //聊天室
+            "member_id": 2,   //聊天室
+            "name": "乐高编程培训A级",
+            "english_name": "Lego Tranning Class",
+            "alias_name": null,
+            "avatar_thumb_url": "https://www.pocket-school.cn//club.png",
+            "avatar_url": "https://www.pocket-school.cn//club.png",
+            "unread_count": 0,
+            "time_stamp": 1698294149,
+            "label": null,
+            "stick_on_top": false,
+            "is_silent": false,
+            "role": "member",
+            "last_message_content": "😁你可以新发一条消息!",
+            "last_message_user_member_id": null,
+            "user_member_id": 1,
+            "chat_announcements_unread_count": 0,
+            "chat_room_kype": "club",
+            "kicked_out_at": 0
+        }
+
+```
+
+## 聊天室管理
+
+```json
+  {
+            "id": 1,
+            "chat_room_id": 1, //聊天室
+            "member_id": 2,   //聊天室
+            "name": "乐高编程培训A级",
+            "english_name": "Lego Tranning Class",
+            "alias_name": null,
+            "avatar_thumb_url": "https://www.pocket-school.cn//club.png",
+            "avatar_url": "https://www.pocket-school.cn//club.png",
+            "unread_count": 0,
+            "time_stamp": 1698294149,
+            "label": null,
+            "stick_on_top": false,
+            "is_silent": false,
+            "role": "member",
+            "last_message_content": "😁你可以新发一条消息!",
+            "last_message_user_member_id": null,
+            "user_member_id": 1,
+            "chat_announcements_unread_count": 0,
+            "chat_room_kype": "club",
+            "kicked_out_at": 0
+        }
+
+```
diff --git a/json_rules/index.md b/json_rules/index.md
@@ -0,0 +1,139 @@
+# 产品说明文档
+
+## 产品描述
+
+<!-- :::warning 模块说明
+后台包含了所有学校内部管理自己数据的功能和流程，方便老师们可以自主的管理自己学校内的数据。
+Vue3 + TS + Pinia + Vite
+::: -->
+
+## 学生管理
+
+:::info 学生模块说明
+学生模块主要以招生办老师使用， 学生的底线可以添加登录账号等等。登录账号可以是家长。
+:::
+
+- 学生报表
+- 在校生管理
+- 申请人管理
+- 离校生管理
+- 毕业生管理
+- 学生标签管理
+- 学生模块权限管理
+
+### 学生请假模块
+- 学生请假统计
+- 学生请假列表
+
+### 学生点名模块
+- 学生点名统计
+- 学生点名列表
+- 异常学生清单
+
+## 老师管理
+- 老师报表
+- 申请老师管理
+- 试用期老师管理
+- 在职老师管理
+- 离职老师管理
+- 老师标签管理
+- 老师模块权限管理
+
+### 老师请假模块
+- 请假报表
+- 请假列表
+
+### 老师考勤模块
+- 考勤报表
+- 考勤列表
+
+
+## 班级模块
+:::info
+    设计上面，我想校车，俱乐部，课后班，暑假班，甚至校车。都可以以班级模块的表为基础做构建。
+:::
+
+### 班级模块
+- 班级报表
+- 待开班班级管理
+- 进行中班级管理
+- 已关闭班级管理
+- 班级通知模块 #增删改查
+- 班级课程表模块 #增删改查
+- 班级标签管理
+- 班级模块权限管理
+
+
+### 俱乐部管理
+- 俱乐部报表
+- 待开班俱乐部
+- 进行中俱乐部
+- 已关闭俱乐部
+- 俱乐部通知模块 #增删改查
+- 俱乐部时间表 #跟班级通知一样
+- 校车乘车记录 #跟班级点名一样
+- 俱乐部标签管理
+- 俱乐部模块权限
+
+### 校车模块
+- 校车报表
+- 校车列表 #增删改查
+- 校车通知 #跟班级通知一样
+- 校车乘车记录 #点名的
+- 校车统计
+
+
+### 班级附属模块
+- 班级点名
+- 班级通知
+- 课程表管理
+- 学生评估分组
+- 学生评估记录
+- 每个老师有自己的评估标准
+
+
+## 教学管理
+
+### 学科管理
+- 学科列表
+
+### 作业管理系统
+- 作业报表
+- 作业列表
+- 学生作业记录管理
+
+
+## 教务管理
+- 全校通知
+### 问卷管理
+- 问卷报表
+- 问卷标签
+- 问卷填写记录
+
+### 工作流管理
+- 工作流报表
+- 工作台管理
+- 工作台分类管理
+- 工作流列表
+- 工作流模块权限
+
+### 财务管理
+----通用
+- 财务报表
+- 财务类目管理
+- 财务收款方式管理 #申请微信支付宝
+
+---- 收入
+- 收费账单管理
+- 缴费记录管理
+- 缴费日志（微信，支付宝）
+
+---- 支出
+- 支出账单管理
+- 支出记录管理
+- 支出日志
+
+## 小程序管理
+- 小程序报表
+- 小程序模块
+- 小程序列表
diff --git a/json_rules/user.md b/json_rules/user.md
@@ -0,0 +1,27 @@
+# 用户，档案，公司体系
+
+## 用户 User
+
+这里的用户指的是一个账号。用户不做太多约束
+
+```json
+
+```
+
+
+## 公司表 Company
+
+
+```json
+
+```
+## 档案表 Member
+
+```json
+
+```
+## 身份表 UserMember
+
+```json
+
+```