Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 1.89 KB

README.md

File metadata and controls

49 lines (30 loc) · 1.89 KB
Raw

BIOM-Mass Portal UI

Portal UI design inspired by the iHMP Data Portal and developed with the framework from the NIH NCI GDC Data Portal.

Data sets and metadata hosted and access controlled by the Broad Institute FireCloud.

The GraphQL server used with this portal is the BIOM-Mass FireCloud GraphQL server.

Technologies

  • React - JavaScript library for building user interfaces
  • Relay - JavaScript framework for building data-driven React applications
  • Redux - Predictable state container for JavaScript apps
  • Recompose - React utility belt for function components and higher-order components
  • Flow - Static type checker for JavaScript
  • Jest - Delightful JavaScript testing
  • d3 - Data-Driven Documents

Installation

Install Watchman with Homebrew with the command $ brew install watchman.

Install the other required packages for this portal with $ npm i (use Node v8 (npm v5)).

Run

Development

Install the BIOM-Mass GraphQL server and start it running.

Next start the portal ui with the command $ npm start.

Production

  1. Start the BIOM-Mass GraphQL server running.
  2. Build the source for the UI with $ npm run-script build.
  3. Build the docker image with $ sudo docker build -n portal-ui ..
  4. Start the docker container (allowing access to host ports) $ sudo docker run -d --network=host --name portal_ui portal_ui.

Schema

To generate a schema of the local GraphQL server run the command $ node ./data/getSchema.