From d5aed2b328a7e3dd1e337257011ca51a822c9c94 Mon Sep 17 00:00:00 2001 From: robinvandermolen Date: Wed, 20 Nov 2024 09:07:31 +0100 Subject: [PATCH] :memo: [#4796] Documenting the rx-mission docker environment --- docker/rx-mission/README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docker/rx-mission/README.md diff --git a/docker/rx-mission/README.md b/docker/rx-mission/README.md new file mode 100644 index 0000000000..d93abce3df --- /dev/null +++ b/docker/rx-mission/README.md @@ -0,0 +1,28 @@ +# RX Mission + +The `docker-compose.rx-mission.yml` compose file is available to run a mock services intended +to replicate some Roxit interfaces. Currently only containing a mock product detail endpoint. + +The compose file takes some serious creative liberty, and doesn't represent a real Roxit environment. +At the moment we cannot use a real Roxit products environment, +so this mock service shall have to do for the development and testing of #4796. + +The data returned from `/product/` is a stripped example provided by Roxit, +and very loosely depicts real products. + +When development of the Roxit products environment is completed, this docker environment must be updated. + +## docker compose + +Start an instance in your local environment from the parent directory: + +```bash +docker compose -f docker-compose.rx-mission.yml up -d +``` + +This starts a flask application at http://localhost:80/product/. +To recognized `uuid's` can be found in the `rx-mission/fixtures/rx-mission-products.json` file. + +## Load fixtures + +The flask app uses the fixtures in `rx-mission/fixtures` as a simple database.