search

CDLUC3 / mrt-dashboard

Merritt Dashboard
4 stars 1 forks source link

readme

Merritt Dashboard (Merritt UI)

This microservice is part of the Merritt Preservation System.

Purpose

This microservice provides the User Interface for the Merritt Perservation System.

Component Diagram

%%{init: {'theme': 'neutral', 'securityLevel': 'loose', 'themeVariables': {'fontFamily': 'arial'}}}%%
graph TD
  RDS[(Inventory DB)]
  UI("Merritt UI")
  click UI href "https://github.com/CDLUC3/mrt-dashboard" "source code"
  ING(Ingest)
  click ING href "https://github.com/CDLUC3/mrt-ingest" "source code"
  ST(Storage)
  click ST href "https://github.com/CDLUC3/mrt-store" "source code"
  LDAP[/LDAP\]
  BROWSER[[Browser]]

  subgraph Merritt
    BROWSER --> UI
    RDS --> UI
    UI --> |"file or manifest"| ING
    UI --> |authorization| LDAP
    UI ---> |retrieval req| ST
  end

  style RDS fill:#F68D2F
  style LDAP fill:cyan
  style UI stroke:red,stroke-width:4px

API Summary

Swagger Documentation

Dependencies

This code depends on the following Merritt Libraries.

For external audiences

This code is not intended to be run apart from the Merritt Preservation System.

See Merritt Docker for a description of how to build a test instnce of Merritt.

Build instructions

Ruby bundler is used to build this application.

Test instructions

GitHub Actions are used to test this application.

RSpec and Capybara tests exist for this application.

Internal Links