Skip to content

STARIONGROUP/reqifviewer

Repository files navigation

reqifviewer

Quality Gate Status Code Smells Coverage Duplicated Lines (%) Lines of Code Maintainability Rating Reliability Rating Security Rating Technical Debt Vulnerabilities

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.

Visit https://viewer.reqifsharp.org to see the application in action.

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.

The Docker command needs to be executed from the commandline in the solution folder.

$ ./solutionfolder# docker build -f reqifviewer/Dockerfile -t stariongroup/reqifviewer:latest .
$ ./solutionfolder# docker run -p 8080:80 --name reqifviewer stariongroup/reqifviewer:latest

Push to docker hub

$ ./solutionfolder# docker push stariongroup/reqifviewer:latest

Autodeployment

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, find it at https://viewer.reqifsharp.org.

Build Status

GitHub actions are used to build and test the library

Branch Build Status
Master Build Status
Development Build Status

License

The reqifviewer is provided to the community under the Apache License 2.0.

Contributions

Contributions to the code-base are welcome. However, before we can accept your contributions we ask any contributor to sign the Contributor License Agreement (CLA) and send this digitaly signed to [email protected]. You can find the CLA's in the CLA folder.