-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 [#4796] Documenting the rx-mission docker environment
- Loading branch information
1 parent
0913b11
commit d5aed2b
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/<product_uuid>` 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/<product_uuid>. | ||
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. |