Skip to content

Commit

Permalink
Merge pull request #3 from e-gov/main-for-0.9.1
Browse files Browse the repository at this point in the history
improve README.md for 0.9.1
  • Loading branch information
aasaru authored Jun 16, 2023
2 parents b184486 + a97257f commit 843cc9f
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,17 @@ and create their own database views and stored functions.
## Sequence diagram illustrating the application
![Sequence diagram](doc/sequence-diagram-pr.png)

## Running
## Running the built docker image

Every time this repository is tag-ed with a new version,
GitHub Actions builds a public Docker image and uploads it to GitHub Container Registry (ghcr.io)
See [the details of recent actions](https://github.com/e-gov/PH-sample-provider-python/actions) and [the list of tags](https://github.com/e-gov/PH-sample-provider-python/tags).

For example, one can get the version 0.9.0 like this:
`docker pull ghcr.io/e-gov/ph-sample-provider-python:v0.9.0`
`docker pull --platform linux/x86_64 ghcr.io/e-gov/ph-sample-provider-python:v0.9.0` (Mac)

## Running locally

Use Docker-compose to start up a Postgres database and the application.
The scripts create a few tables to sore information about mandates and views and functions to interact
Expand Down

0 comments on commit 843cc9f

Please sign in to comment.