📝 describe target Architecture and Tools

josuablejeru · Sep 7, 2023 · f09c5ed · f09c5ed
1 parent ed42b25
commit f09c5ed
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -3,13 +3,26 @@
 this api is a small demo app to see how a stock resupply
 Mobile app might work for a small Mom & Pop's shop using Odoo.
 
-![swaggerui](assets/swagger.png)
+## Architecture
+![architecture_diagram](./assets/odoo-resupply-api.png)
+> This is WIP for now and the target architecture and always subject to change!
+> 
+The Resupply API interacts with Odoo via Hasura.
+Because of this, no major modification or modules have to be made for Odoo.
+I recommend using Keycloak as a OIDC provider to make things simple,
+but it can also be used only for the Inventory Resupply App.
+
 
 ## Tools used
 
-- Spring Boot
+- Spring Boot / Spring Security
 - Postgres
 - Swagger UI / OpenAPI 3.0
+- docker compose
+- testcontainers
+- liquidbase / hibernate
+
+![swaggerui](assets/swagger.png)
 
 ## Docker Compose
 ```yaml

diff --git a/assets/odoo-resupply-api.png b/assets/odoo-resupply-api.png