BioMiner Components

A set of React components for BioInformatics, such as Gene/Transcript Map from GTex Portal, Pathology Image Viewer, etc.

Demo

More details on ui-components.3steps.cn

Getting Started

Clone the repository

git clone github.com/yjcyxky/biominer-components.git
cd biominer-components

Install dependencies

$ yarn install

Start the dev server

Before you start the dev server, you need to run a biomedgps server locally (Port: 8000). Please refer to biomedgps for more details. You might need to fill a token into the localStorage of your browser for accessing the biomedgps server.

$ yarn start

Publish docs to github pages

yarn deploy

Build documentation

$ yarn docs:build

Run test

$ yarn test

Build library via father

$ yarn build

Publish library to npm

Please update the version in package.json before publishing.

$ npm publish .

For developers

Only for developers who want to develop this package locally.

Install yalc globally

$ npm i -g yalc

Publish your local package to yalc

yalc publish

Go to your project and install the package from yalc

yalc add biominer-components

Update the local package and push to yalc

yarn build && yalc push

Go to your project and rebuild the package

rm -rf src/.umi && yarn start:local-dev