ソースを参照

前后端关系图

visuddhinanda 4 年 前
コミット
62493cdf47
1 ファイル変更143 行追加157 行削除
  1. 143 157
      documents/zh/dashboard/readme.md

+ 143 - 157
documents/zh/dashboard/readme.md

@@ -2,15 +2,15 @@
 
 本文档是网站页面的前端设计文档
 
-
 # 开发环境
-- React
-- Umijs
-- Ant Design
-- Type Script
 
+-   React
+-   Umijs
+-   Ant Design
+-   Type Script
 
 # 网站地图
+
 ```mermaid
 graph LR;
 
@@ -45,187 +45,173 @@ dict -->|嵌入| wbw
 reader -->wbw
 term -->|嵌入| wbw
 ```
-- 藏经阁-Libray
-  - [首页](home.md)
-  - [三藏](palicanon.md)  
-  - [课程](course.md)
-  - [字典](dict.md)
-  - [搜索](search.md)
-  - [个人空间](myzone.md)
-- 译经楼-Studio
-  - [首页](stu_home.md) 
-  - [三藏分类](stu_pali.md)
-  - [我的文档(最近打开)](stu_doc.md)
-  - [逐词解析编辑](stu_wbw.md)
-  - [协作文档](stu_coop.md)
-  - [群组管理](stu_group.md)
-  - [版本管理](stu_channel.md)
-  - [课程管理](stu_course.md)
-  - [单词本](stu_dict.md)
-  - [百科词条](stu_term.md)
-  - 统计数据
-- 用户中心- User Center
-  - [注册](sign_up.md)
-  - [登陆](sign_in.md)
-  - 找回密码
-  - 个性化设置
-- 实用工具
-  - 佛历
-  - 圣典编码转换
-- 后台管理
-  - 栏目内容管理
-  - 用户管理
-  - 数据表管理
 
-# 藏经阁-Libray
+-   藏经阁-Libray
+    -   [首页](home.md)
+    -   [三藏](palicanon.md)
+    -   [课程](course.md)
+    -   [字典](dict.md)
+    -   [搜索](search.md)
+    -   [个人空间](myzone.md)
+-   译经楼-Studio
+    -   [首页](stu_home.md)
+    -   [三藏分类](stu_pali.md)
+    -   [我的文档(最近打开)](stu_doc.md)
+    -   [逐词解析编辑](stu_wbw.md)
+    -   [协作文档](stu_coop.md)
+    -   [群组管理](stu_group.md)
+    -   [版本管理](stu_channel.md)
+    -   [课程管理](stu_course.md)
+    -   [单词本](stu_dict.md)
+    -   [百科词条](stu_term.md)
+    -   [文章](stu_article.md)
+    -   [文集](stu_collection.md)
+    -   统计数据
+-   用户中心- User Center
+    -   [注册](sign_up.md)
+    -   [登陆](sign_in.md)
+    -   找回密码
+    -   个性化设置
+-   实用工具
+    -   佛历
+    -   圣典编码转换
+-   后台管理
+    -   栏目内容管理
+    -   用户管理
+    -   数据表管理
+
+# 调用后端 API
 
-## 首页
+```mermaid
+graph LR
+
+subgraph 前端
+	subgraph 藏经阁-Libray
+    	home[首页]
+		palicanon[三藏]
+		course[课程]
+		dict[字典]
+		search[搜索]
+		myzone[个人空间]
+	end
+	subgraph 译经楼-Studio
+		stu_home[首页]
+		stu_pali[三藏分类]
+		stu_doc[我的文档]
+		stu_wbw[逐词解析编辑]
+		stu_coop[协作文档]
+		stu_group[群组管理]
+		stu_channel[版本管理]
+		stu_course[课程管理]
+		stu_dict[单词本]
+		stu_term[百科词条]
+		stu_article[文章]
+		stu_collection[文集]
+		统计数据
+	end
+	subgraph 用户-User
+		sign_up[注册]
+		sign_in[登陆]
+		找回密码
+		个性化设置
+	end
+	subgraph 实用工具
+		佛历
+		圣典编码转换
+	end
+	subgraph 后台管理
+		栏目内容管理
+		用户管理
+		数据表管理
+	end
+end
 
-www.wikipali.org
+subgraph API
+	api_user(用户)
+	api_channel(版本)
+	api_term[术语]
+	api_dict[字典]
+	api_course[课程]
+	api_group[工作组]
+	api_palicanon[语料库]
+	api_translation[译文]
+	api_article[文章文集]
+	api_wbw[逐词解析]
+	api_search[全文搜索]
+	api_history[浏览记录]
+	api_others[其他工具表]
+end
 
-### 已经实现的功能能
+home --> api_course
+home --> api_term
+home --> api_article
 
-- 最新课程列表
-- 最新百科词条列表
+palicanon --> api_palicanon
+palicanon --> api_term
 
-### 需要完善的功能
+course --> api_course
+course --> api_user
 
-#### 最新课程列表
+dict --> api_dict
+dict --> api_user
 
-- 返回数量是写死的。应该在栏目后台里可以设置。
+search --> api_palicanon
 
-### 尚未实现的功能(目前的需求)
+myzone --> api_user
+myzone --> api_course
 
-- **最新课程列表**-报名数字显示和报名功能
+stu_pali --> api_palicanon
 
-- 最新三藏译文列表
+stu_doc --> api_history
 
-- 手机版 css
-  - 写不同的 css 在手机端和 pc 看到不同的页面。
-  - 不一定用 css 切换,可以使用不同的技术实现方式。
+stu_wbw --> api_wbw
+stu_wbw --> api_palicanon
 
-### 未来可能的发展
+stu_group --> api_group
 
-- 实现类似 tweet 的文章推荐功能。根据用户阅读行为推荐不同类型和内容的文章。
-- 文章类型
-  - 逐词解析单词
-  - 词典词条
-  - 百科词条
-  - 句子
-  - 段落
-  - 章节
-- 文章属性标签
-  - 译文
-  - 新手试验田
-  - 雅正(希望大家提修改意见)
-  - 求助
-- 应用场景
-  - 当有学习者不知道某个词的拆分,他在编辑器(studio)中单词的位置选择“求助”按钮。会发布一个带有“求助”标签的“逐词解析”类型的文章。某老师或网友看到求助文章,可以以跟帖的方式回答。
+```
 
+# 藏经阁-Libray
 
-## 三藏分类
+## 首页
 
-www.wikipali.org/palicanon
+www.wikipali.org
 
 ### 已经实现的功能能
 
-- 章节标签过滤
-- 在阅读器中打开章节
+-   最新课程列表
+-   最新百科词条列表
 
 ### 需要完善的功能
 
-### 尚未实现的功能(目前的需求)
-
-### 未来可能的发展
-
-## 课程
-
-### 已经实现的功能能
+#### 最新课程列表
 
-### 需要完善的功能
+-   返回数量是写死的。应该在栏目后台里可以设置。
 
 ### 尚未实现的功能(目前的需求)
 
-### 未来可能的发展
-
-## 百科
-
-### 已经实现的功能能
+-   **最新课程列表**-报名数字显示和报名功能
 
-### 需要完善的功能
+-   最新三藏译文列表
 
-### 尚未实现的功能(目前的需求)
+-   手机版 css
+    -   写不同的 css 在手机端和 pc 看到不同的页面。
+    -   不一定用 css 切换,可以使用不同的技术实现方式。
 
 ### 未来可能的发展
 
-## 字典
-
-## 标题搜索
-
-## 全文搜索
-
-## 黑体字搜索
-
-## 经典阅读器
-
-# 译经楼 Studio
-
-## 欢迎页
-
-## 经文选择
-
-## 最近打开
-
-## 协作
-
-## 课程管理
-
-## 用户字典管理
-
-## 百科字典管理
-
-## 工作组管理
-
-# 用户中心
-
-## 登录
-
-## 注册
-
-## 用户设置
-
-# 网站后台管理
-
-## 栏目管理
-
-### 首页
-
-### 三藏
-
-### 课程
-
-### 百科
-
-### 字典
-
-### 搜索
-
-### 阅读器
-
-### 用户管理
-
-#### 修改权限
-
-#### 禁用账号
-
-### 数据表管理
-
-#### 查看
-
-#### 统计
-
-#### 添加
-
-#### 删除
-
-# 数据表与模块关系
+-   实现类似 tweet 的文章推荐功能。根据用户阅读行为推荐不同类型和内容的文章。
+-   文章类型
+    -   逐词解析单词
+    -   词典词条
+    -   百科词条
+    -   句子
+    -   段落
+    -   章节
+-   文章属性标签
+    -   译文
+    -   新手试验田
+    -   雅正(希望大家提修改意见)
+    -   求助
+-   应用场景
+    -   当有学习者不知道某个词的拆分,他在编辑器(studio)中单词的位置选择“求助”按钮。会发布一个带有“求助”标签的“逐词解析”类型的文章。某老师或网友看到求助文章,可以以跟帖的方式回答。