Skip to content

Commit

Permalink
[Update] Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sam.gerene committed Dec 5, 2021
1 parent ddf4a6b commit f115f24
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -19,4 +18,9 @@ $ ./solutionfolder# docker run -p 8080:80 --name reqifviewer rheagroup/reqifview
Push to docker hub

```
$ ./solutionfolder# docker push rheagroup/reqifviewer:latest
$ ./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.

0 comments on commit f115f24

Please sign in to comment.