mirrors/postgsail
1
0
Fork 0
mirror of https://github.com/xbgmsharp/postgsail.git synced 2025-09-17 11:17:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
xbgmsharp
2024-02-23 23:49:17 +01:00
parent 36173658a0
commit 414736909b
3 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -54,9 +54,9 @@ To understand the why and how, you might want to read [Why.md](https://github.co
## Architecture ## Architecture
A simple scalable 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 ## 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: Then launch the web frontend, execute:
```bash ```bash
$ docker compose build web $ docker compose up web
``` ```
The frontend should be accessible via port HTTP/8080.
### SQL Configuration ### SQL Configuration

6
docs/ERD/README.md
View File

@@ -4,7 +4,7 @@ The Entity-Relationship Diagram (ERD) provides a graphical representation of dat
## A global overview ## A global overview
Auto generated Mermaid diagram using [mermerd](https://github.com/KarnerTh/mermerd) and [MermaidJs](https://github.com/mermaid-js/mermaid). 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 ## Further
There is 3 main schemas: There is 3 main schemas:
@@ -45,7 +45,7 @@ There is 3 main schemas:
## Ingest flowchart ## Ingest flowchart
```mermaid ```mermaid
graph LR graph LR
A[SignalK] -- HTTP POST --> B{PostGREST} A[SignalK] -- HTTP POST --> B{PostgREST}
B -- SQL --> C{PostgreSQL} B -- SQL --> C{PostgreSQL}
C --> D((metadata trigger)) C --> D((metadata trigger))
C --> E((metrics trigger)) C --> E((metrics trigger))
@@ -57,7 +57,7 @@ graph LR
## pg_cron flowchart ## pg_cron flowchart
```mermaid ```mermaid
graph LR flowchart TD
A[pg_cron] --> B((cron_new_notification)) A[pg_cron] --> B((cron_new_notification))
A --> C((cron_pre_logbook)) A --> C((cron_pre_logbook))
A --> D((cron_new_logbook)) A --> D((cron_new_logbook))

2
docs/README.md
View File

@@ -1,2 +1,4 @@
Simple and scalable architecture. Simple and scalable architecture.
![Architecture overview](https://raw.githubusercontent.com/xbgmsharp/postgsail/main/PostgSail.png "Architecture overview")