Master分支

![Build Status]([] ![Dependency Status]([] ![devDependency Status]([] ![Commitizen friendly]([]

Develop分支

![Build Status]([] ![Dependency Status]([] ![devDependency Status]([] ![Commitizen friendly]([]

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

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

开发

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

配置

提供程序

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

认证服务器

• 默认情况下，应用程序期望其运行在[***]。
• 认证服务器的URL可通过REACT_APP_AUTH_SERVER环境变量配置。
• 认证服务器的二进制文件可从其发布页面下载。下载适合您操作系统的版本，并确保始终使用最新版本。
• REACT_APP_AUTH_SERVER环境变量也可通过修改env文件中的全局变量进行自定义。

API服务器

• 默认情况下，应用程序期望其运行在[***]。
• API服务器的URL可通过REACT_APP_API_SERVER环境变量配置。
• 当前使用Kubeless Node.js和Golang函数，并映射到此URL。所有Node.js函数都是运行此应用程序1.0.0版本所必需的。
• REACT_APP_API_SERVER环境变量也可通过修改env文件中的全局变量进行自定义。

导航栏和页脚

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

语义化版本控制

此应用程序已设置使用semantic-release和commitizen。添加新提交后（git add .），使用npm run cz并按照提示对提交进行分类和提供更多详细信息。完成后，将更改推送到您正在工作的分支。

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

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

重要提示：您必须存储GH_TOKEN或GITHUB_TOKEN环境变量，其中包含GitHub 个人访问令牌。您可以在运行脚本时手动传递（即GH_TOKEN=XXX npx semantic-release），也可以在本地存储环境变量。

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

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

• npm install
• npm start

应用程序结构

这已重新配置为使用create-react-app的结构和理念。有关更多详细信息，请阅读其用户指南。

.
├── 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软件的部署过程的更多详细信息，请参见此处。

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

• genefn
• genecachefn
• uniprotcachefn

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