Supreme Court Viewer

This repository contains the stand alone Supreme Court Viewer application. This application allows authorized individuals to review file details and access the electronic versions of the related documentation.

Running in Docker

Refer to Running the Application on Docker to details.

Running on OpenShift

The OpenShift build and deployment configurations for the project can be found here; bcgov/supreme-court-viewer-configurations

High Level Architecture

API Documentation

For high level View API documentation refer to the diagram above. For details, refer to the router and view components source code.

For backend API documentation refer to the Swagger API documentation page available at the api/ endpoint of the running application. For example, if you are running the application locally in docker, the Swagger page can be found at https://localhost:8080/scjscv/api/. Refer to Running in Docker section for details.

Getting Help or Reporting an Issue

To report bugs/issues/feature requests, please file an issue.

Deployment Process

flowchart TD
 subgraph Pipeline["Build on Merge"]
    direction LR
        E1(Docker Build)
        E2(Push Image to Artifactory)
        E3(Update gitops repo)
  end
 subgraph ArgoCD["Argo CD"]
    direction LR
        F1(Detect Change)
        F2(Synchronize Charts)
        F3(Deploy to OpenShift)
  end
    E1 --> E2 -- SHA tag --> E3
    F1 --> F2 --> F3
    A("Perform Code Changes")
    A --> B("Pull Request")
    B --> C@{shape: event, label: "Merge PR"}
    C --> E[["GitHub Actions"]]
    E --> F[["Argo CD"]]
    E -.- Pipeline
    F -.- ArgoCD

%% Styling
  E:::gitActionStyle
  F:::argoStlye
  Pipeline:::gitActionStyle
  ArgoCD:::argoStlye
  classDef default fill: #FFF
  classDef gitActionStyle stroke: #AA00FF,fill: #FFF
  classDef argoStlye stroke: #00FF88,fill: #FFF

Loading

GitOps flow (only release context)

This diagram hints at the process to release to the affiliated environments. This does not indicate the required work to configuring

flowchart LR
        G1(DEV: Develop branch updated by actions)
        G1 --PR--> G2(TEST: Manually promoted to test)
        G2 --PR--> G3(PROD: Manually promoted to prod)
%% Styling
  classDef default fill: #FFF

Loading

How to Contribute

If you would like to contribute, please see our CONTRIBUTING guidelines.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.