Skip to content
This repository has been archived by the owner on Apr 16, 2024. It is now read-only.

Latest commit

 

History

History
115 lines (74 loc) · 5.03 KB

README.md

File metadata and controls

115 lines (74 loc) · 5.03 KB

Important

Archive Notice: The DMS-UI is now known as Stage. You can find the updated Stage repository here.


Data Management System - UI

arranger-logo

The DMS-UI is a React-based user interface designed to prop up browser-accessible data portals. Although the DMS-UI can be used for any web application, it is designed to integrate with Overture's Ego and Arranger microservices.

The DMS-UI is a Next.js project bootstrapped with create-next-app.

For more information about the DMS-UI, including setup and how to integrate Overture microservices Arranger and Ego, see our official DMS-UI user documentation


The DMS-UI is part of the Overture research software ecosystem. See our related products for more information on how Overture is helping organize data and enable discovery.


Features

  • URL parameterization support
  • Extensible layout, with primary and secondary menus
  • Reusable UI components
  • Theme customization

Getting Started

  1. Install the dependencies
  npm ci
  1. Run the development server
  npm run dev

Once running the DMS-UI is available from your http://localhost:3000

You can edit the UI by modifying pages/index.js. The UI will auto-update as you edit.

Note: This app was tested using Node v16+. We recommend using this version if you encounter any issues.

Troubleshooting Note:

DMS-UI requires NPM v^8.3.0, to ensure all dependencies get installed correctly

# If you need to update your NPM version first, use the following command:
  npm i -g npm

Learn More

To learn more about Next.js, take a look at the following resources:

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

Support & Contributions

Related Products

Overture overview

Overture is an ecosystem of research software tools, each with narrow responsibilities, designed to reduce redundant programming efforts and enable developers and data scientists to build reliable systems that organize and share big data.

All our core microservices are included in the Overture Data Management System (DMS). The DMS offers turnkey installation, configuration, and deployment of Overture software. For more information on the DMS, read our DMS documentation.

See the links below for additional information on our other research software tools:


Software Description
Ego An authorization and user management service
Ego UI A UI for managing Ego authentication and authorization services
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 UI components that build into configurable and functional data portals
DMS-UI 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, and additional funding from Genome Canada, the Canada Foundation for Innovation, the Canadian Institutes of Health Research, Canarie, and the Ontario Institute for Cancer Research.