search

WATonomous / watcloud-emails

A collection of email templates used by WATcloud
MIT License
0 stars 1 forks source link
watcloud

readme

watcloud-emails

A collection of email templates used by WATcloud.

Getting started

  1. Find a version from the releases page (e.g. 0.0.2).
  2. Run the following command 
    VERSION=<version>
npx https://github.com/WATonomous/watcloud-emails/releases/download/v${VERSION}/watonomous-watcloud-emails-${VERSION}.tgz --help

Development

npm ci
npm run dev

Open localhost:3000 with your browser to see email previews.

Run the following to use the CLI:

node ./dist/cli/index.js

Releasing

Releases are manually created from the Releases page. CI will automatically build the tarball and publish it to the release page. Release notes can be auto-generated via the web interface.

Please follow semantic versioning when creating tags for releases. Tags should be prefixed with v (e.g. v1.0.0). Version numbers less than 1.0.0 should be considered unstable and may have breaking changes in minor versions.