wireapp/wire-emails

Name: wire-emails

Owner: Wire Swiss GmbH

Description: Templates for sending emails for Wire

Created: 2018-02-07 16:34:37.0

Updated: 2018-04-17 13:50:18.0

Pushed: 2018-04-17 13:50:20.0

Homepage: https://wireapp.github.io/wire-emails/dist/

Size: 5431

Language: HTML

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

wire-emails

Build Status

Templates for sending emails, based on Foundation for Emails.

Visit wireapp.github.io/wire-emails/dist for the latest ? Live Preview ?

Help translate our emails via the Crowdin project.

For Designers

If the files are not updated Otto-matically with the Otto build commit message, check the commit list for possible errors.

To update shared text modules like headers, footers or signatures, edit the corresponding files in the src/partials/en folder.

For Engineers

We recommend you set up the wire-emails repo to run locally on your computer so you can verify your changes before pushing them to the live site.

The instructions below assume you're on a Mac with Homebrew installed.

Installation
  1. Install the yarn JavaScript package manager via Homebrew:

     install yarn
    
  2. Clone this repository and run yarn from the root directory of your clone to install the necessary dependencies:

     add global foundation-cli
    
    
Start the local preview

This repository provides a local preview, so you can see what the final messages will look like.

To start the preview, run yarn start and check the results at localhost:3000.

A table of contents appears with links to each message. Click a link to display the rendered message content.

Update

When you update the HTML files in the src folder, the results should be reflected automatically in the browser.

If not, make sure the local preview server is running or check the console for errors.

Build

Run yarn build to inline your CSS into your HTML along with the rest of the build process.

Translations

All translations are located in the Crowdin project.

When the original (English) email copy is changed via the GitHub UI or in a local clone and submitted via a pull request, the modified source text is uploaded to Crowdin for translation.

Translators use the Crowdin UI to update the localized text strings.

Once the pull request is merged to master, the new translations are fetched from Crowdin and automatically downloaded into the project.

Otto builds

When you commit to master, Otto will tell Travis to generate the new email templates and add an Otto build message to the commits list. The absense of the Otto build will indicate an error as seen in the sreenshot below:

Commit screenshot


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.