diff --git a/README.md b/README.md index b7b36e6..4230491 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,49 @@ -# private_health +# Private Health +This project aims to create the necessary building blocks in order to allow collect and analyze one's personal health data in a privacy-oriented manner. Instead of closed-source apps and dubious clouds, it should use a FLOSS stack. + + +## Architecture + +```mermaid +flowchart LR + scale(("bathroom
scale")) + A["openscale"] + B["openscale sync"] + hc["HealthConnect API
(or similar)"] + + fitness_tracker(("fitness
tracker")) + gb["Gadgetbridge"] + gb_sync["(Gadgetbridge sync?)"] + + nc[("Nextcloud")] + + bpm(("blood
pressure
monitor")) + --> bpm_app["BPM app"] + --> hc + + scale-->A + --> B + --> hc + + fitness_tracker + --> gb + --> gb_sync + --> hc + + hc --> nha["Nextcloud (health) app"] + + nha --> nc + + nc --> cA["Web UI
(Dashboard, statistics)"] + nc --> cB["mobile devices"] + nc --> cC["...other clients..."] + + classDef green fill:#8fb935,stroke:#333; + classDef yellow fill:#e6e22e,stroke:#333; + classDef orange fill:#e09c3b,stroke:#333,stroke-width:4px; + classDef red fill:#e64747,stroke:#333,stroke-width:4px; + class A,B,gb,hc green; + class bpm_app,gb_sync,cA,nc orange; + class nha red; +```