yevis-web

Web application for browsing Yevis workflow registry.

https://ddbj.github.io/workflow-registry-browser/ is deployed for ddbj/workflow-registry.

In addition, see the below links:

• ddbj/workflow-registry: a workflow registry built and maintained by DDBJ using yevis-cli
• sapporo-wes/yevis-cli: a CLI tool to support building and maintaining the Yevis workflow registry
• Yevis Getting Started: the document for Yevis system installation and usage
• Yevis Getting Started Ja: 日本語での Yevis system の使い方

Build and Deploy

We used node.js v18.x and Google Chrome for development. If you use an older version of node.js, yevis-web may not work properly. At least, the dependent library Vite requires node.js >= 14.6.0.

Deploy to GitHub Pages

See Yevis Getting Started.

You can build and deploy using GitHub Action and GitHub Pages.

Deploy to other than GitHub Pages

See Vite - Guide - Deploying a Static Site as a reference.

Build and local preview:

$ npm ci
$ npm run build
$ npm run preview

---

To manage the yevis-web, describe a .env file as follows:

VITE_WF_REPO=ddbj/workflow-registry
VITE_WF_REPO_GH_PAGES_BRANCH=gh-pages
VITE_TRS_ENDPOINT=https://ddbj.github.io/workflow-registry/

As an explanation of these variables:

• VITE_WF_REPO: GitHub repository deployed by yevis-cli.
• VITE_WF_REPO_GH_PAGES_BRANCH: A branch name of the GitHub repository deployed by yevis-cli.
• VITE_TRS_ENDPOINT: An endpoint of the GA4GH Tool Registry Service (TRS) API. Usually, an endpoint of GitHub Pages.

This example is set with default values. Create a .env file and set them to change them.

---

Pass the environment variable YEVIS_WEB_BASE to set the base at build time (See Vite - Guide - GitHub Pages as a reference):

$ YEVIS_WEB_BASE=/yevis-web/ npm run build
$ YEVIS_WEB_BASE=/yevis-web/ npm run preview

Development

Launch the development server:

$ npm ci
$ npm run dev
> yevis-web@0.0.0 dev
> vite
  vite v2.8.3 dev server running at:

  > Local: http://localhost:3000/
  > Network: use `--host` to expose

License

Apache-2.0. See the LICENSE.