Heckle

A sample project for a progressive web application - see more on the architecture.

tl;dr

Add the chart repo:

helm repo add heckle https://holzeis.github.io/heckle
helm install heckle heckle/heckle -f values.yaml # create your own values.yaml

Web Push

Heckle uses the WebPush Protocol to push notifications to user agents through push services. In order to distinguish between legitimate and bogus requests push services require a voluntary application server identification (VAPID).

Generate VAPID keys

Generate a valid private / public key pair using the web-push cli like described below.

npm install -g web-push
web-push generate-vapid-keys

Use the resulting private and public key in the vapid section of the values.yaml.

vapid:
  publicKey: "<public key>"
  privateKey: "<private key>"

Dummy Users

Heckle doesn't implement an user authentication but uses plain jwt token to identify the current user. Dummy users are simply loaded via configuration. See accounts.json for possible test users.

Couchdb Persistency

Heckle stores talks and heckles into a couchdb which is defined as dependency to the heckle chart. Configure the couchdb parameters via the couchdb section.

See couchdb chart for configuration details.

Configuration Values

See heckle chart values for default values.