Browse Source

:recycle: 精简、合并开发文档

Vito Van 4 years ago
parent
commit
037b756752
3 changed files with 59 additions and 226 deletions
  1. 59 109
      README.md
  2. 0 47
      documents/dev-doc.md
  3. 0 70
      documents/readme.md

+ 59 - 109
README.md

@@ -1,109 +1,59 @@
-# [PCD-Suite](https://github.com/iapt-platform/PCD-Suite)的 Rust&React 重写版
-
-## 目录
-
-|目录|用途|备注|
-|-|-|-|
-|app|旧的项目目录||
-|dashboard|前端代码||
-|api|后端代码||
-|documents|开发文档||
-|docker|podman 启动脚本||
-|font|网站所使用的字体||
-|dicttext|字典数据文件csv格式||
-|docker|podman 启动脚本||
-|pali_title|三藏标题csv|更新csv文件后,运行install/***.php更新数据库|
-|phphtml|三藏原文数据|html格式,来自pced|
-|paliword|巴利文献单词表 |用三藏原文数据库导出的单词表生成|以后考虑服务器端生成|
-
-## 安装
-
-MacOS
-```bash
-cd mint; mkdir tmp; chown -R www:www tmp
-```
-
-然后进入 http://localhost/app/install 开始安装
-
-## 开发
-### 技术栈
-#### 前端
-- react
-- umijs
-- ant design pro
-- Tapescript
-
-#### 后端
-- PostgreSQL
-- elasticsearch
-- golang
-- Redis
-  
-### 工具
-
-#### 推荐使用 **VSCode**, 常用插件列表
-
--   [ESLint](https://github.com/Microsoft/vscode-eslint)
--   [Rust(rls)](https://github.com/rust-lang/rls-vscode)
--   [Icons](https://github.com/vscode-icons/vscode-icons)
--   [OneDark Pro](https://github.com/Binaryify/OneDark-Pro)
--   [Better Toml](https://github.com/bungcip/better-toml)
--   [Prettier - Code formatter](https://github.com/prettier/prettier-vscode)
--   [SQL Formatter](https://github.com/kufii/vscode-sql-formatter)
-
-#### 数据库管理工具
-- [通用数据库管理工具-dbeaver](https://github.com/dbeaver/dbeaver)
-- [redis图形界面工具-RedisDesktopManager](https://github.com/uglide/RedisDesktopManager)
-
-### Git commit message 规范
-git commit message格式 请参见 https://gitmoji.dev/
-
--   遵循 git pull request 流程
--   所有代码必须经过格式化
--   禁止提交测试中间数据、key、db 等文件
--   Git commit message 格式
-    -   每条 message 不超过一行
-    -   每个 commit 应该是独立的一个 issue 任务
-    -   message 格式 `:code: message body`
-    -   code 定义
-        -   bug fix: `:bug:`
-        -   new feature: `:construction:`
-        -   document: `:pencil:`
-        -   ops: `:rocket:`
-        -   config file: `:wrench:`
-        -   test case: `::white_check_mark:`
-
-### 资源格式
-
--   文字统一使用**markdown**格式
--   图片
-    -   尽量使用**png**格式
-    -   如果是 svg 或 graphiz 绘图,**附带源代码**
-    -   **禁止**使用未经授权的图片
-
-## 部署
-
-```bash
-$ ssh-copy-id deploy@xxx.xxx.xxx.xxx
-$ RUST_LOG=info axis -i staging -r deploy
-```
-
-## 文档
-
-### 后端
-
--   [MinIO is a high performance object storage server compatible with Amazon S3 APIs](https://github.com/minio/minio)
--   [Diesel: A safe, extensible ORM and Query Builder for Rust](https://github.com/diesel-rs/diesel)
--   [Actix web is a small, pragmatic, and extremely fast rust web framework](https://github.com/actix/actix-web)
-
-### 前端
-
--   [Pluggable enterprise-level react application framework](https://umijs.org/)
--   [Ant Desigh Pro](https://pro.ant.design/docs/getting-started)
--   [Third-Party Libraries](https://ant.design/docs/react/recommendation)
-
-### Git
-
--   [About git pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
--   [how to write a git commit message:](https://chris.beams.io/posts/git-commit/)
--   [An emoji guide for your commit messages](https://gitmoji.carloscuesta.me/)
+# 巴利圣典教育开放平台 - IAPT Platform
+
+IAPT = International Academy Of Pali Tipitaka - 国际巴利三藏学院
+
+试运行地址:https://www.wikipali.org/
+
+# 平台愿景
+
+让巴利圣典的学习变得更容易,人人都能从巴利圣典中受益。
+
+了解更多:https://youtu.be/HMACYkZryJQ
+
+# 当前功能
+
+- 巴利圣典阅读与翻译
+- 在线课程发布与学习
+- 在线巴利语学习工具
+
+# 重构计划
+
+随着平台功能的完善,以及用户量的增加,当前平台面临以下几个问题
+
+- 性能瓶颈
+  多用户并发操作以及全文检索效率低,难以支撑更多的用户
+- 代码维护
+  当前代码内含有相当量的冗余和临时解决方案,难以扩展和维护
+- 权限管理
+  权限管理模块有瑕疵,多人协作编辑功能有待优化
+
+基于以上几个问题,现启动平台重构计划。
+
+以解决问题为目标,细化任务,逐步实施。
+
+# 关于我们
+
+国际巴利三藏学院,致力于让佛陀所揭示的真理可以平等的被所有族群方便的学习与运用。
+
+希望在传统和现代、老师与学生、翻译者与读者之间假设桥梁。向他们提供教育平台,享受前沿的教学科技,实现各种信息及资源的有效共享。指导圣典在人类生命系统净化提升的实践与运用。让全世界所有族群都可以享受高品质的圣典教育,最终实现圣典教育全球化。
+
+- 巴利语文献语料库的建立
+- 相关参考文献的电子化
+- 巴利文献的整理翻译及研究
+- 基于项目培养相关人才,实现产学研一体化发展。
+
+# 参与开发
+
+关注此 [项目看板](https://github.com/orgs/iapt-platform/projects/5)
+
+发现有合适的待领取(To do 状态)任务时,联系 Visuddhinanda(email:visuddhinanda@gmail.com) 加入。
+
+技术细节:暂时请先尝试阅读代码,重构结束后会有补充完整的开发文档。
+
+# 什么是巴利圣典?
+
+巴利圣典乘载着佛陀的教导。
+
+从佛陀入灭后一个月开始,五百位阿拉汉僧人作了集结会议,将佛陀所宣说的法完整的背诵了下来,在这2600多年中一共经历了六次的集结会议,将教法传承至今。因主要分为三个部分律藏、经藏、论藏,因此一般也称作巴利三藏。
+
+Pāli 即是圣典的意思,是以古印度语言为基础的文献,目前这种语言已不在于日常被使用,只用于传承佛法,因此也将此语言直接称作巴利语(Pāli language),为了避免混淆,通常在语言翻译上,会将「巴利」(表示语言)和「圣典」(表示典籍)分开,将它称作巴利圣典。

+ 0 - 47
documents/dev-doc.md

@@ -1,47 +0,0 @@
-# 巴利圣典教育开放平台 - IAPT Platform
-
-IAPT = International Academy Of Pali Tipitaka - 国际巴利三藏学院
-
-试运行地址:https://www.wikipali.org/
-
-# 平台愿景
-
-让巴利圣典的学习变得更容易,人人都能从巴利圣典中受益。
-
-# 当前功能
-
-- 巴利圣典阅读与翻译
-- 在线课程发布与学习
-- 在线巴利语学习工具
-
-# 重构计划
-
-随着平台功能的完善,以及用户量的增加,当前平台面临以下几个问题
-
-- 性能瓶颈
-  多用户并发操作以及全文检索效率低,难以支撑更多的用户
-- 代码维护
-  当前代码内含有相当量的冗余和临时解决方案,难以扩展和维护
-- 权限管理
-  权限管理模块有瑕疵,多人协作编辑功能有待优化
-
-基于以上几个问题,现启动平台重构计划。
-
-以解决问题为目标,细化任务,逐步实施。
-
-# 关于我们
-
-国际巴利三藏学院致力于让佛陀所揭示的真理可以平等的被所有族群方便的学习与运用。希望在传统和现代、老师与学生、翻译者与读者之间假设桥梁。向他们提供教育平台,享受前沿的教学科技,实现各种信息及资源的有效共享。指导圣典在人类生命系统净化提升的实践与运用。让全世界所有族群都可以享受高品质的圣典教育,最终实现圣典教育全球化。
-
-- 巴利语文献语料库的建立
-- 相关参考文献的电子化
-- 巴利文献的整理翻译及研究
-- 基于项目培养相关人才,实现产学研一体化发展。
-
-# 参与开发
-
-关注此 [任务看板](https://github.com/orgs/iapt-platform/projects/5) 
-
-发现有合适的待领取(To do 状态)任务时,联系 Visuddhinanda(email:visuddhinanda@gmail.com) 加入。
-
-技术细节:暂时请先尝试阅读代码,重构结束后会有补充完整的开发文档。

+ 0 - 70
documents/readme.md

@@ -1,70 +0,0 @@
-
-## 巴利圣典教育开放平台
-
-### 网站平台
-
-这是一个包含多个实用工具(如:字典)在内的在线巴利语文字处理软件。
-
-这个软件帮助您:
-- 逐词解析巴利原文——巴利语的专业级教案
-- 注释与书签——记录课堂笔记和疑难问题
-- 多版本译文逐句添加和比对——翻译者的好朋友
-- 智能佛教术语——更加轻松地维护译文术语
-- 智能单词本——减少重复劳动
-- 共享与协作——与平台上的其他人共同破解经文的奥秘
-
-
-目前平台还在开发阶段。如果您对平台开发感兴趣,请点击:[详情](development/join_us.md)
-### 在线课程
-老师的**逐个巴利词讲解**这种授课模式在佛教国家流传千年至今,仍然是重要的教学手段。借助软件的**逐词解析功能**,学生可以方便快捷地记录。
-
-我们邀请佛教国家的老师,利用网络课堂技术帮助学生体验这种传统而有效的教学方式。让您能加速实现巴利语的学以致用——早日畅游巴利圣典。
-课程范例
-### 圣典翻译计划
-
-包含根本、义注和复注在内的圣典宝库共包含150多本书。多个世纪以来,一代一代的僧侣守护着这个宝库。巴利教育软件平台和特别安排的在线课程邀请你来探索。我们鼓励你将这些珍宝翻译为你的母语。
-
-欢迎参与这个教育计划,更多的关于课程和翻译计划的信息请[参阅](course/join_us.md)
-
-## 关于我们
-这是一个由巴利圣典爱好者组成的团队。这里的“爱好者”并非指“专业人士”的反面。相反的,此团体由各个领域的专业人士组成。
-大家因为出于对佛法的热爱而聚集在一起。创建一个无国界,无版权的开放的巴利圣典教育平台。
-
-在此平台上,无论老师与学生,内容的创建者或是读者。都以令正法久住为目的贡献自己的智慧。
-您的加入将会给所有热爱佛法的人带来至上的利益。
-
-## Resources相关资源
-### videos视频
-上座部三藏註釋书翻譯項目的構想(2019) [Youtube](https://www.youtube.com/playlist?list=PLgavmc8e-GuWR-FKOr-7RfnUSWX82ED0q)
-[百度网盘](https://pan.baidu.com/s/1VW789wYHLNwA9VP21bmyJQ)
-
-
-conference of translating platform 三藏翻译工程暨教育平台搭建会议简报 
-- [Youtube](https://www.youtube.com/playlist?list=PL_1iJBQvNPFHT6UisME_cOSts5fFecK14)
-- [百度网盘链接](https://pan.baidu.com/s/10_e7vYGyewy7_TIPgmht5A) 提取码:pali
-
-Due to the unstable connection the online video conference had been influnced, organizers re-recorded this presentation by screen shot after the conference.
-由于会议现场网络出现故障,导致会议直播时断时续,为保证质量,会务组于会后以录屏的方式进行了重新录制。
-
-[functions demo 功能演示](https://www.youtube.com/playlist?list=PL_1iJBQvNPFFNLOaZh2u3VwDYUyJuK_xa)
-
-[Example Class 课程范例](https://www.youtube.com/playlist?list=PL_1iJBQvNPFHwP1ZL4sbhtJTnYeMiEm29)
-
-
-### web demo 网站演示版
-
-visit [www.wikipali.org/](https://www.wikipali.org/) to scan, test and check for the developer only, not for the normal users.
-
-
-访问[www.wikipali.org/](https://www.wikipali.org/) 仅仅是针对开发者来进行浏览、测试和检查的,而不是面向普通用户。
-
-### code for wikipali website Demo 网站演示版代码
-1. If anyone want to push his github code to the server, please contact with Ven. Bhikkhu Visuddhinanda and Ven. Bhikkhu Kosalla by wechat or teams.
-想要将其github上的代码推送至服务器,请微信联络Bhikkhu Visuddhinanda和Bhikkhu Kosalla.
-2. download and install "gitbash", "TortoiseGit" and "github desktop" and make the submit and communication esay.
-下载并安装"gitbash", "TortoiseGit"和"github desktop"来进行代码提交,这样相互交流更加便捷。
-
-
-### Others 其他
-
-[collection of conference papers 会议文集](https://drive.google.com/file/d/1CDPKLXMUX30IXc27BeNleHI3uI5OhsFL/view?usp=sharing)(2020.2.12-14)