ElyBy-Mirror/emails-renderer
1
0
Fork 0
mirror of https://github.com/elyby/emails-renderer.git synced 2024-11-26 08:41:59 +05:30
Code Issues Packages Projects Releases Wiki Activity
Tool for rendering multilingual templates sent to E-mail
47 Commits 1 Branch 0 Tags 567 KiB
TypeScript 51.7%
JavaScript 45.6%
Dockerfile 1.4%
EJS 1.3%
71021a52c9
Go to file
ErickSkrauch 71021a52c9 Migrate project's code base to TypeScript
2019-05-13 02:27:07 +03:00
scripts Integrate crowdin and pull locales 2019-05-11 01:16:21 +03:00
src Migrate project's code base to TypeScript 2019-05-13 02:27:07 +03:00
webpack-utils Implemented font image renderer 2019-05-10 01:53:28 +03:00
.eslintrc.json Support for components in BitmapText 2016-10-01 11:06:47 +03:00
.gitignore Use files instead of data uri. Added option to define assetsHost 2016-09-27 08:02:19 +03:00
package.json Migrate project's code base to TypeScript 2019-05-13 02:27:07 +03:00
README.md Use files instead of data uri. Added option to define assetsHost 2016-09-27 08:02:19 +03:00
tsconfig.json Migrate project's code base to TypeScript 2019-05-13 02:27:07 +03:00
webpack.config.js Migrate project's code base to TypeScript 2019-05-13 02:27:07 +03:00
yarn.lock Migrate project's code base to TypeScript 2019-05-13 02:27:07 +03:00

README.md

This package allows rendering of React components into plain HTML to use it in emails. Each directory in emails dir corresponds to separate email template. Each email component will receive payload, passed from command line:

node cli --type=<email_dir_name> --payload=<json_encoded_in_base64> [--assetsHost=<scheme://host:port>] [--locale=be]

Try php example.php for demo.

Email component structure

  • index.js — required. This file should export the main component, wich will receive payload.
  • fixtures.js — an optional file exports hash {featureId: payload, featureId2: payload}. Use this to create data samples for testing in dev mode.
  • styles.js — an optional file, that will hold style objects for email components to allow style inlining.
  • messages.intl.json — an optional file, that exports hash with {messageId: defaultMessage} for react-intl.

Available npm scripts

  • npm start — starts app in dev mode.
  • npm run i18n — collects translations and places in src/i18n.
  • npm run build — builds app for usage in cli.js.
  • npm run eslint — lints source files.