From f115f2473b04412e937c336e411499e32dc963a4 Mon Sep 17 00:00:00 2001 From: "sam.gerene" Date: Sun, 5 Dec 2021 16:31:30 +0100 Subject: [PATCH] [Update] Readme --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b71dfa8..21e1f76 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ # reqifviewer -The reqifviewer is a web application to inspect and navigate ReqIF files. The web application is developed using Blazor and depends on ReqIFSharp for ReqIF processing. +The reqifviewer is a web application to inspect and navigate [ReqIF](https://www.omg.org/spec/ReqIF/1.2/About-ReqIF/) files. The web application is developed using Blazor and depends on [ReqIFSharp](https://reqifsharp.org) for [ReqIF](https://www.omg.org/spec/ReqIF/1.2/About-ReqIF/) processing. -### Build and Deploy using Docker +> Visit https://reqifviewer.reqifsharp.org to see the application in action. -reqifviewer is dockerized and pushed to dockerhub using a GitHub action that is triggered by pushing a tag that has the following naming convention `web-app-x.y.z`, where x.y.z is the version numbr following SEMVER. -The server where the docker container is hosted automatically pulls latest using watchtower +## Build and Deploy using Docker The reqifviewer SPA is built using docker and the result is a Docker container ready to be deployed (or pushed to Docker Hub). The Docker file is located in the reqifviewer project folder. @@ -19,4 +18,9 @@ $ ./solutionfolder# docker run -p 8080:80 --name reqifviewer rheagroup/reqifview Push to docker hub ``` -$ ./solutionfolder# docker push rheagroup/reqifviewer:latest \ No newline at end of file +$ ./solutionfolder# docker push rheagroup/reqifviewer:latest +``` + +## Autodeployment + +reqifviewer is dockerized and pushed to [dockerhub](https://hub.docker.com/repository/docker/rheagroup/reqifviewer) using a GitHub action that is triggered by pushing a **tag** that has the following naming convention `web-app-x.y.z`, where x.y.z is the version numbr following [SEMVER](https://semver.org/). The server where the docker container is hosted automatically pulls latest using [watchtower](https://github.com/containrrr/watchtower), find it at https://reqifviewer.reqifsharp.org. \ No newline at end of file