Helix Web Services (HWS)
------------------------

Please note this is **alpha** software.

The Helix Web Services are a group of microservices used to provide additional
features and easier application integration on a Helix Versioning Engine.

Official deployment and documentation is in progress. 


## Architectural Overview

Our bootstrapping system will set up a single machine with all required
services. 

    ┌──────────────────────────────────────────────────────────────────────────────────────────────────────────┐
    │ ┌───┐                                                                                                    │
    │ │   │  ┌─────────────────────────────────┐                         ┌────┐                                │
    │ │   ├──▶      p4_web_api (Unicorn)       ┣━━━━━━━━━━━━━━━━━━━━━━━━━▶p4d │                                │
    │ │   │  └─────────────────────────────────◀ ─ ┐         ┏━━━━━━━━━━━┻━━──┘                                │
    │ │   │                                                  ┃                                                 │
    │ │   │  ┌─────────────────────────────────┐   │         ┃                                                 │
    │ │   ├──▶   p4_project_services (Puma)    ├────────────┐┃                                                 │
    │ │   │  └─────────────────────────────────◀ ─ ┤        │┃           ┌───────────────────────────────┐     │
    │ │ n │                                                 │┃           │      project_services DB      │     │
    │ │ g │  ┌─────────────────────────────────┐   │        └╋───────────▶         (PostgreSQL)          │     │
    │ │ i ├──▶   p4_phoenix_services (Puma)    ├────────────┐┃           └───────────────────────────────┘     │
    │ │ n │  └─────────────────────────────────◀ ─ ┤        │┃           ┌───────────────────────────────┐     │
    │ │ x │                                                 │┃           │      phoenix_services DB      │     │
    │ │   │  ┌─────────────────────────────────┐   │        └╋───────────▶         (PostgreSQL)          │     │
    │ │   ├──▶ phoenix_updater (EM-WebSocket)  ◀ ─ ─         ┃           └───────────────────────────────┘     │
    │ │   │  └─────────────────────────────────┘   │         ┃           ┌───────────────────────────────┐     │
    │ │   │                                                 ┌╋───────────▶   notification_services DB    │     │
    │ │   │  ┌─────────────────────────────────◀━━━╋━━━━━━━━╋┛           │         (PostgreSQL)          │     │
    │ │   ├──▶  notification_services (Puma)   ◀ ─ ─        │            └───────────────────────────────┘     │
    │ │   │  └─────────────────────────────────┴───┼────────┤                                                  │
    │ │   │                                                 │                                                  │
    │ └───┘                                        │        │            ┌───────────────────────────────┐     │
    │                                                       └────────────▶  notification_queue (Redis)   │     │
    │                                          ┌───┴───────────┐         └───────────────────────────────┘     │
    │                                          │               │                                               │
    │                                          │      god      │                                               │
    │                                          │               │                                               │
    │                                          └───────────────┘                                               │
    │                                                                                                          │
    │                                                                                                          │
    │                                                                                                          │
    │                                                                                                          │
    │                                                                                                          │
    └──────────────────────────────────────────────────────────────────────────────────────────────────────────┘