/avo2-client

Het Archief voor Onderwijs 2 - client app

Primary LanguageTypeScript

Het Archief voor Onderwijs - client app

Synopsis

This repository contains the React AVO Client app front-end for the end user.

Technical

Role Handle / username
Principal/Owner Bart Debunne bart.debunne@viaa.be
Lead Developer Enzo Eghermanne enzo.eghermanne@studiohyperdrive.be
Lead Developer Bert Verhelst bert.verhelst@studiohyperdrive.be
Developer Benjamin Naesen benjamin.naesen@studiohyperdrive.be
Developer Andry Charlier andry.charlier@studiohyperdrive.be

Code Review:

Functional

The React AVO Client app will provide the following:

  • Implementation of the React @viaa/components in screens for the end user
  • Coupling with the NodeJS proxy for authentication & search

Server

QAS PRD
host TODO TODO

Stack

Backend

NodeJS proxy w/Typescript and Express.js

Frontend

Logging and monitoring

Backend

// TODO

Deployment/Installation

Prerequisites

Front-end

Jenkins builds a docker image and uploads it to the viaa docker registry.

Usage

Examples

See postman collection (TODO add link)

Troubleshooting

Deploy to QAS

Steps to deploy:

  • Update package.json version to match release branch version
  • Do npm install or update the version of the package-lock.json file version
  • Extract translations
  • Merge release branch into master
  • This deploys to qas if the integration tests succeed

Deploy to PROD

  • Add tag on master + push the tag (format: v1.1.1)
  • Wait for build to succeed (eta 20min)

Troubleshoot deploy

If the deploy completes successfully but the version on the server doesn't seem to update, this could be an issue with the image not automatically being selected by openshift

Steps:

  • You can login to openshift
  • Go to Deployments > avo2-client-qas
  • Actions > edit at the top right
  • Scroll down to Image Stream Tag and select the correct image in the dropdown on the right
  • Save, wait for image to be deloyed

Note:

  • the correct image should normally be the tag containing the environment name (eg: qas for qas environment)
  • This image is automatically updated when a new deploy occurs
  • When you select a different image than the env image, the auto updating behavior will not happen anymore

Process Flow

Flow

Diagram