dictybase/genomepage

Master分支

![Build Status]([] ![Dependency Status]([] ![devDependency Status]([***]

Develop分支

![Build Status]([] ![Dependency Status]([] ![devDependency Status]([***]

用于在dictyBase展示基因组信息的Web应用程序

• 开发
  • 配置
    • 提供程序
    • 认证服务器
    • API服务器
    • 导航栏和页脚
  • 语义化版本控制
  • 运行应用程序（开发版本）
  • 应用程序结构
• 部署

开发

• 首先克隆此仓库。
• 接下来按照以下说明配置应用程序。

配置

提供程序

• 这是最重要的部分，运行应用程序绝对需要。
• 将提供的示例文件clientConfig.sample.js复制到同一文件夹下的clientConfig.js。
• 然后添加提供程序名称及其对应的客户端ID。
• 所有提供程序都应在oauthConfig.js文件中有对应的配置。为该文件中的每个新提供程序填写所有配置参数。
• 对于每个提供程序名称，登录路由中将显示相应的登录按钮。支持的按钮列表可在此处找到。

认证服务器

• 默认情况下，应用程序期望其运行在https://betatoken.dictybase.local。
• 认证服务器的URL可通过REACT_APP_AUTH_SERVER环境变量配置。
• 认证服务器的二进制文件可从其发布https://github.com/dictybase/authserver/releases%E4%B8%8B%E8%BD%BD%E3%80%82%E4%B8%8B%E8%BD%BD%E9%80%82%E5%90%88%E6%82%A8%E6%93%8D%E4%BD%9C%E7%B3%BB%E7%BB%9F%E7%9A%84%E7%89%88%E6%9C%AC%EF%BC%8C%E5%B9%B6%E7%A1%AE%E4%BF%9D%E5%A7%8B%E7%BB%88%E4%BD%BF%E7%94%A8%E6%9C%80%E6%96%B0%E7%89%88%E6%9C%AC%E3%80%82
• REACT_APP_AUTH_SERVER环境变量也可通过修改env文件中的全局变量进行自定义。

API服务器

• 默认情况下，应用程序期望其运行在https://betafunc.dictybase.local。
• API服务器的URL可通过REACT_APP_API_SERVER环境变量配置。
• 当前使用Kubeless https://github.com/dictybase-playground/kubeless-nodefn%E5%92%8Chttps://github.com/dictybase-playground/kubeless-gofn%E5%87%BD%E6%95%B0%EF%BC%8C%E5%B9%B6%E6%98%A0%E5%B0%84%E5%88%B0%E6%AD%A4URL%E3%80%82%E6%89%80%E6%9C%89%60Node.js%60%E5%87%BD%E6%95%B0%E9%83%BD%E6%98%AF%E8%BF%90%E8%A1%8C%E6%AD%A4%E5%BA%94%E7%94%A8%E7%A8%8B%E5%BA%8F1.0.0%E7%89%88%E6%9C%AC%E6%89%80%E5%BF%85%E9%9C%80%E7%9A%84%E3%80%82
• REACT_APP_API_SERVER环境变量也可通过修改env文件中的全局变量进行自定义。

导航栏和页脚

• 应用程序的环境变量REACT_APP_NAVBAR_JSON和REACT_APP_FOOTER_JSON设置为GitHub上存储JSON数据的相应URL。

语义化版本控制

此应用程序已设置使用https://github.com/semantic-release/semantic-release%E5%92%8Chttps://github.com/commitizen/cz-cli%E3%80%82%E6%B7%BB%E5%8A%A0%E6%96%B0%E6%8F%90%E4%BA%A4%E5%90%8E%EF%BC%88%60git add .），使用npm run cz`并按照提示对提交进行分类和提供更多详细信息。完成后，将更改推送到您正在工作的分支。

当您准备推送到生产环境时，可以使用semantic-release自动执行发布过程：

• 将您的更改合并到master分支
• 运行npx semantic-release

重要提示：您必须存储GH_TOKEN或GITHUB_TOKEN环境变量，其中包含GitHub https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/%E3%80%82%E6%82%A8%E5%8F%AF%E4%BB%A5%E5%9C%A8%E8%BF%90%E8%A1%8C%E8%84%9A%E6%9C%AC%E6%97%B6%E6%89%8B%E5%8A%A8%E4%BC%A0%E9%80%92%EF%BC%88%E5%8D%B3%60GH_TOKEN=XXX npx semantic-release`），也可以在本地存储环境变量。

这将查看自上次git tag以来的最新提交，并自动确定发布的适当版本号。它还会更新CHANGELOG文档。

运行应用程序（开发版本）

• npm install
• npm start

应用程序结构

这已重新配置为使用https://github.com/***/create-react-app%E7%9A%84%E7%BB%93%E6%9E%84%E5%92%8C%E7%90%86%E5%BF%B5%E3%80%82%E6%9C%89%E5%85%B3%E6%9B%B4%E5%A4%9A%E8%AF%A6%E7%BB%86%E4%BF%A1%E6%81%AF%EF%BC%8C%E8%AF%B7%E9%98%85%E8%AF%BB%E5%85%B6https://github.com/***/create-react-app/blob/master/packages/react-scripts/template/README.md%E3%80%82

.
├── public                      # Index.html和favicon
├── src                         # 应用程序源代码
│   ├── app                     # 应用程序级组件
│       ├── actions             # 整个应用程序使用的操作（如页脚、导航栏）
│       ├── layout              # 主应用程序模板
│       ├── reducers            # Redux减速器
│       ├── routes              # React Router路由
│       ├── store               # Redux存储配置
│   ├── common                  # 整个应用程序的通用功能
│       ├── components          # 通用组件
│       ├── constants           # 静态数据（如页脚、导航栏链接）
│       ├── fake-data           # 占位符内容所需的任何假数据
│       ├── utils               # 应用程序工具
│   ├── features                # 应用程序的主要功能
│       ├── Authentication      # 身份验证相关组件
│       ├── Blast               # Blast选项卡组件
│       ├── MainPage            # /路由的组件，显示示例基因
│       ├── Ontology            # 基因本体论选项卡组件
│       ├── Orthologs           # 同源物选项卡组件
│       ├── ProteinInformation  # 蛋白质信息选项卡组件
│       ├── Reference           # 参考选项卡组件
│       ├── Summary             # 基因摘要选项卡组件
│   ├── images                  # 应用程序中使用的图像
│   ├── styles                  # 应用程序的任何共享样式
│   └── index.js                # 应用程序渲染
└──                             # 配置文件

部署

应用程序通过构建Docker镜像并通过Kubernetes运行来部署。有关DSC和所有Dicty软件的部署过程的更多详细信息，请参见https://github.com/dictyBase/Migration/blob/master/deploy.md%E3%80%82

从应用程序2.0.0版本开始，还需要部署以下Kubeless函数：

• https://github.com/dictybase-playground/kubeless-nodefn/tree/master/gene
• https://github.com/dictybase-playground/kubeless-nodefn/tree/master/geneids
• https://github.com/dictybase-playground/kubeless-nodefn/tree/master/uniprot

重要提示：确保使用最新版本。按照这些页面上的文档进行部署。