Skip to content

Latest commit

 

History

History
82 lines (59 loc) · 2.92 KB

README.md

File metadata and controls

82 lines (59 loc) · 2.92 KB
Raw

Overture Iobio Components

A set of reusable React components and command line tools for integrating the visualization and analysis software originally created by IOBIO.


Overture Iobio Components is part of Overture, a collection of open-source software microservices used to create platforms for researchers to organize and share genomics data. See our related products for more information on how Overture is helping organize data and enable discovery.

Repository Structure

The repository is organized with the following directory structure:

.
├── apps/
│   └── bam.iobio 
└── packages/
    └── iobio-react-components
        ├── components 
        └── utils

The modules in the monorepo are organized into two categories:

  • apps/ - Demo integration example applications.
  • packages/ - Reusable packages shared between applications and other packages. Packages are published to NPM.

Local development

Development tools

  • PNPM This project is a monorepo managed by PNPM
  • Node.js Runtime environment (v20 or higher)
  • VS Code As recommended code editor. Plugins recommended: ESLint, Prettier - Code formatter, Mocha Test Explorer, Monorepo Workspace

Setup

  1. Install the dependencies
  npm i pnpm -g
  pnpm i
  1. Run Demo App
  cd apps/bam.iobio
  pnpm run dev

Support & Contributions

Related Software

The Overture Platform includes the following Overture Components:


Software Description
Score Transfer data to and from any cloud-based storage system
Song Catalog and manage metadata associated to file data spread across cloud storage systems
Maestro Organizing your distributed data into a centralized Elasticsearch index
Arranger A search API with reusable search UI components
Stage A React-based front-data portal UI
Lyric A data-agnostic tabular data submission system
Lectern A simple web browser UI that integrates Ego and Arranger

Acknowledgements

Overture is supported by grant #U24CA253529 from the National Cancer Institute at the US National Institutes of Health.