克里斯 API

Chris API的JavaScript 6客户端.

安装

npm i @fnndsc/chrisapi

API 文档

如果您有 ChRIS 服务器在运行( 如以下解释), 您可以在您的 Javascript 代码中测试 API .

详情请访问 API 文档

开发和测试

ChRIS 服务器先决条件

这些先决条件只有在能够对客户进行实际测试时才有必要 用于自动测试.

安装最新的 Docker

目前测试的平台 :

• Docker Engine v25.0.0+

在 Linux 机上确保将您的计算机用户添加到 docker group

安装最新 just 指挥跑者.

启动全套Chris服务:

打开终端并在任何工作目录中运行以下命令 :

$> git clone https://github.com/FNNDSC/ChRIS_ultron_backEnd.git
$> cd ChRIS_ultron_backEnd
$> just

检查所有服务是否齐全 :

$> docker ps -a

创建测试数据 :

在此 README 文件目录中运行以下 shell 脚本 . 注:剧本取决于大众 curl 财务报告和审定财务报表 jq 命令行工具.

$> ./pre_test.sh

拆掉全套Chris服务:

以后可以移除所有后端容器并释放存储量,其中:

$ cd ChRIS_ultron_backEnd
$ just nuke

JavaScript 软件包管理器的先决条件

• 线条

在此 README 文件目录中打开终端

图标

安装依赖关系

$> yarn install

以监视模式开始测试( 用于开发)

$> yarn start

在单跑模式下开始测试( 由 Travis CI(中文(简体) )

$> yarn test

编译库以独立捆绑

$> yarn build

生成源代码文档

$> yarn docs