From 6434d113a6e5528aa1ca66afb32bf22976c6e63c Mon Sep 17 00:00:00 2001 From: South Drifted Date: Wed, 19 Jun 2024 22:27:44 +0000 Subject: [PATCH] [add] GitHub actions for Web deployment [optimize] Format & Installation Guide of Read Me document --- .github/workflows/deploy-Web.yml | 26 ++++++ README.md | 107 ++++++++++++++++++++---- {src/data => data}/HyperuricemiaDB.json | 0 {src/data => data}/PsychologicalDB.json | 0 {src/data => data}/nutritionDB.json | 0 src/component/GuideCard.tsx | 2 +- src/page/index.mdx | 6 +- 7 files changed, 121 insertions(+), 20 deletions(-) create mode 100644 .github/workflows/deploy-Web.yml rename {src/data => data}/HyperuricemiaDB.json (100%) rename {src/data => data}/PsychologicalDB.json (100%) rename {src/data => data}/nutritionDB.json (100%) diff --git a/.github/workflows/deploy-Web.yml b/.github/workflows/deploy-Web.yml new file mode 100644 index 0000000..eca22eb --- /dev/null +++ b/.github/workflows/deploy-Web.yml @@ -0,0 +1,26 @@ +name: Web deployment +on: + push: + branches: + - main +jobs: + Build-and-Deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - uses: actions/setup-node@v3 + with: + node-version: 18 + + - name: Install & Build + run: | + npm install + npm run build + + - name: Deploy to GitHub pages + uses: peaceiris/actions-gh-pages@v3 + with: + publish_dir: ./dist + personal_token: ${{ secrets.GITHUB_TOKEN }} + force_orphan: true diff --git a/README.md b/README.md index eb15eff..8eee241 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,132 @@ # KnowledgeBase-xiaoyibao -### 这是 xiaoyibao 扩展项目中的知识库项目，用于存储生成 RAG 所需的医疗专业资料。 +[![Web deployment](https://github.com/xycjscs/KnowledgeBase-xiaoyibao/actions/workflows/deploy-Web.yml/badge.svg)][1] -#### 数据库目录 +这是 xiaoyibao 扩展项目中的知识库项目，用于存储生成 RAG 所需的医疗专业资料。 + +## 数据库目录 [访问当前的数据库目录](https://xycjscs.github.io/KnowledgeBase-xiaoyibao/) 您可以通过此链接查看并访问我们的数据库目录，以便获取相关的信息和资源。 -## 下载数据方法为： +## 下载数据方法 + +### 1. 安装 Python + +#### Windows -#### 1. 安装 Python ```sh -# 安装 Python +winget install python -h +# 或 +choco install python -y +refreshenv ``` -#### 2. 安装 requests 包 +#### Mac + +```sh +brew install python +``` + +#### Linux + +所有标准发行版已内置，如需自行安装最新版，参考：https://idea2app.feishu.cn/docx/doxcngAN2tjRKS9TH8LHQaXVSUa#doxcnMysQm0kYGgkUAtfQETXoRe + +### 2. 更新 PIP 包管理器 + +```sh +python -m pip install --upgrade pip + +# 中国大陆教育网用户切换镜像 +pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple +``` + +### 3. 安装 requests 包 + ```sh pip install requests ``` -#### 3. 执行数据库下载指令 +### 4. 执行数据库下载指令 + ```sh python downloader.py nutritionDB.json ``` -## 计划准备： -#### 1. 癌症患者营养食谱知识库 +## Web 前端 + +### 1. 安装 Node.js 和 Git + +#### Windows + +```sh +winget install OpenJS.NodeJS.LTS Git.Git -h +# 或 +choco install nodejs-lts git -y +``` + +#### Mac + +```sh +brew install git node@18 +``` + +#### Linux + +- [Node.js 官方教程](https://nodejs.org/en/download/package-manager/all) +- [Git 官方教程](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git#_installing_on_linux) + +### 2. 下载源码 + +```sh +cd ~/Desktop +git clone https://github.com/xycjscs/KnowledgeBase-xiaoyibao.git +cd KnowledgeBase-xiaoyibao +``` + +### 3. 安装并启动开发环境 + +```sh +npm install +npm start +``` + +## 计划准备 + +### 1. 癌症患者营养食谱知识库 对应数据库文件为 `nutritionDB.json` -#### 2. 癌症患者心理辅导知识库 +### 2. 癌症患者心理辅导知识库 对应数据库文件为 `PsychologicalDB.json` -#### 3. 高尿酸人群饮食知识库 +### 3. 高尿酸人群饮食知识库 对应数据库文件为 `HyperuricemiaDB.json` -## 资料通过“下载链接+下载脚本”形式储存。 +> 资料通过“下载链接+下载脚本”形式储存。 计划仓库中不同 json 文档存储不同的 `{标题-说明-链接}` 库，README 文件自动读取 json 文件渲染首页，下载脚本自动读取 json 并执行下载。 ## 维基百科形式的协作 + 文档以维基百科的形式进行协同创作，任何人可以修改文档中的任何内容，包括删减不合适的目录。 贡献者可通过修改 json 文件提交代码，提交代码前需要检查下载脚本是否可以正确执行。 ## 待开发功能或资料 -[ ] 自动化PDF文档转markdown文本 -[ ] QA对数据库 +- [ ] 自动化 PDF 文档转 Markdown 文本 + + - https://github.com/bsorrentino/pdf-tools + - https://github.com/opengovsg/pdf2md + +- [ ] QA 对数据库 + +- [ ] 专业人士审核机制 -[ ] 专业人士审核机制 +- [x] 自动将文档更新于一链接 -[X] 自动将文档更新于一链接 \ No newline at end of file +[1]: https://github.com/xycjscs/KnowledgeBase-xiaoyibao/actions/workflows/deploy-Web.yml diff --git a/src/data/HyperuricemiaDB.json b/data/HyperuricemiaDB.json similarity index 100% rename from src/data/HyperuricemiaDB.json rename to data/HyperuricemiaDB.json diff --git a/src/data/PsychologicalDB.json b/data/PsychologicalDB.json similarity index 100% rename from src/data/PsychologicalDB.json rename to data/PsychologicalDB.json diff --git a/src/data/nutritionDB.json b/data/nutritionDB.json similarity index 100% rename from src/data/nutritionDB.json rename to data/nutritionDB.json diff --git a/src/component/GuideCard.tsx b/src/component/GuideCard.tsx index 525c9e5..8b0b014 100644 --- a/src/component/GuideCard.tsx +++ b/src/component/GuideCard.tsx @@ -1,4 +1,4 @@ -import NutritionDB from "../data/nutritionDB.json"; +import NutritionDB from "../../data/nutritionDB.json"; export type Guide = (typeof NutritionDB)[0]; diff --git a/src/page/index.mdx b/src/page/index.mdx index 540d0b9..2c7a9f6 100644 --- a/src/page/index.mdx +++ b/src/page/index.mdx @@ -1,8 +1,8 @@ import { GuideSection } from "../component/GuideSection"; -import HyperuricemiaDB from "../data/HyperuricemiaDB.json"; -import PsychologicalDB from "../data/PsychologicalDB.json"; -import NutritionDB from "../data/nutritionDB.json"; +import HyperuricemiaDB from "../../data/HyperuricemiaDB.json"; +import PsychologicalDB from "../../data/PsychologicalDB.json"; +import NutritionDB from "../../data/nutritionDB.json"; # 癌症患者支援数据库