From 414736909b71ee617c8f827a201cccef6120ab6c Mon Sep 17 00:00:00 2001 From: xbgmsharp Date: Fri, 23 Feb 2024 23:49:17 +0100 Subject: [PATCH] Update README --- README.md | 7 ++++--- docs/ERD/README.md | 6 +++--- docs/README.md | 2 ++ 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7127265..718dc91 100644 --- a/README.md +++ b/README.md @@ -54,9 +54,9 @@ To understand the why and how, you might want to read [Why.md](https://github.co ## Architecture A simple scalable architecture: -![Architecture overview](https://raw.githubusercontent.com/xbgmsharp/postgsail/main/PostgSail.png "Architecture overview") +For more clarity and visibility the complete [Architecture overview](https://github.com/xbgmsharp/postgsail/blob/main/docs/README.md). -For more clarity and visibility the complete [Entity-Relationship Diagram (ERD)](https://github.com/xbgmsharp/postgsail/tree/main/ERD/README.md) is export as PNG and SVG file. +For more clarity and visibility the complete [Entity-Relationship Diagram (ERD)](https://github.com/xbgmsharp/postgsail/blob/main/docs/ERD/README.md) is export as Mermaid, PNG and SVG file. ## Cloud @@ -132,8 +132,9 @@ You can connect to the database via a web gui like [pgadmin](https://www.pgadmin Then launch the web frontend, execute: ```bash -$ docker compose build web +$ docker compose up web ``` +The frontend should be accessible via port HTTP/8080. ### SQL Configuration diff --git a/docs/ERD/README.md b/docs/ERD/README.md index c63efcb..8941052 100644 --- a/docs/ERD/README.md +++ b/docs/ERD/README.md @@ -4,7 +4,7 @@ The Entity-Relationship Diagram (ERD) provides a graphical representation of dat ## A global overview Auto generated Mermaid diagram using [mermerd](https://github.com/KarnerTh/mermerd) and [MermaidJs](https://github.com/mermaid-js/mermaid). -![PostgSail SQL Schema](https://github.com/xbgmsharp/postgsail/tree/main/docs/ERD/postgsail.md "PostgSail SQL Schema") +[PostgSail SQL Schema](https://github.com/xbgmsharp/postgsail/tree/main/docs/ERD/postgsail.md "PostgSail SQL Schema") ## Further There is 3 main schemas: @@ -45,7 +45,7 @@ There is 3 main schemas: ## Ingest flowchart ```mermaid graph LR - A[SignalK] -- HTTP POST --> B{PostGREST} + A[SignalK] -- HTTP POST --> B{PostgREST} B -- SQL --> C{PostgreSQL} C --> D((metadata trigger)) C --> E((metrics trigger)) @@ -57,7 +57,7 @@ graph LR ## pg_cron flowchart ```mermaid -graph LR +flowchart TD A[pg_cron] --> B((cron_new_notification)) A --> C((cron_pre_logbook)) A --> D((cron_new_logbook)) diff --git a/docs/README.md b/docs/README.md index 0e5f1c0..4021df1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,2 +1,4 @@ Simple and scalable architecture. + +![Architecture overview](https://raw.githubusercontent.com/xbgmsharp/postgsail/main/PostgSail.png "Architecture overview")