labshare/vision-ui repository overview

⁠Vision UI

⁠Overview

This is a LabShare application that provides an interface for data exploration.

⁠User Guide

View user guide here⁠.

⁠Tutorial

• Install all the packages: npm i

• To run this project in development mode, use the command line: ng serve

• To build this project as a production bundle, use the command line: ng build --prod="true"

• This project depends on the backend Node.js project, Vision API⁠.

• The Vision application reads data from CSV files hosted on the backend. In order to generate data visualizations in browser, the backend API reads and caches data from CSV files stored on the host server, accessible via the running application.

⁠Contents

• src - Main Code folder.
• app - Main App Folder.
• features: Main UI features, all the current's project central components.
• flow-cytometry: Code / Css / Html / TS for the interactive scatterplots.
• data-stores: Includes central store and api services.
• engines: Contains primarily buisness logic.
• factories: Factories create objects.
• managers: Contain orchestration and some logic.
• models: Data models

⁠Deployment

1. Create a .env file in the root of the repository, using sample-env as an example.
2. Configure kubectl with a kubeconfig pointing to the correct Kubernetes cluster. Optionally, pass the location of the kubeconfig file in the .env. This value defaults to the standard kubeconfig location.
3. Run the script using: ./deploy.sh.

⁠License

MIT