README.md

Human Reference Atlas (HRA) User Interfaces

Table of Contents

1. About HRA UI
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License

About HRA UI

This repository contains all the Human Reference Atlas (HRA) User Interfaces.

For detailed information, please refer to the documentation for each app.

• ASCT+B API - Backend Server for ASCT+B Reporter.
• ASCT+B Reporter - Visualization tool for displaying flattened ASCT+B tables.
• CCF Body UI Web Component - A web component used in Exploration User Interface.
• Exploration User Interface - An interactive tool for exploring and validating spatially registered tissue blocks and cell-type populations.
• CCF Organ Info - User Interface for Organ Information.
• Registration User Interfce - An interactive tool for registering tissue blocks spatially and annotating them semantically using ASCT+B Table terms.
• Cell Distance Explorer - Compute, visualize, and explore distance distributions between different cells, cell types, anatomical structures, and more.
• Cell Distance Explorer Visualization Web Component - A web component used in Cell Distance Explorer.
• HRA Dashboards - Explore usage statistics of atlas data and code.
• FTU UI - Examine cell type abundance and biomarker expression values for functional tissue units (FTUs).
• FTU UI Small Web Component - A web component used in FTU Explorer.
• Humanatlas - 3D Multiscale Biomolecular Human Reference Atlas Construction, Visualization, and Usage.
• Medical Illustration - A web component used in FTU Explorer.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

To get a local copy up follow these simple example steps.

Prerequisites

• npm:

  npm install npm@latest -g

Installation

1. Clone the repo:

   git clone https://github.com/hubmapconsortium/hra-ui.git

2. Install NPM packages:

   npm install

(back to top)

Usage

To serve any app use this command:

$ npx nx run app-name:serve

For example, if the app name is cde-ui, use the following command:

$ npx nx run cde-ui:serve

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project.
2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
3. Commit your Changes (git commit -m 'Add some AmazingFeature').
4. Push to the Branch (git push origin feature/AmazingFeature).
5. Open a Pull Request.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)