https://github.com/julie-ng/antwort-cli
CLI for Automated Email Development, incl. template generation and inlining CSS
https://github.com/julie-ng/antwort-cli
cli dev-server email-template inline-css
Last synced: 6 months ago
JSON representation
CLI for Automated Email Development, incl. template generation and inlining CSS
- Host: GitHub
- URL: https://github.com/julie-ng/antwort-cli
- Owner: julie-ng
- Created: 2014-08-14T13:00:46.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2017-12-30T19:38:24.000Z (almost 8 years ago)
- Last Synced: 2024-04-14T07:19:18.440Z (over 1 year ago)
- Topics: cli, dev-server, email-template, inline-css
- Language: Ruby
- Homepage:
- Size: 355 KB
- Stars: 11
- Watchers: 5
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Antwort E-Mail Generator
[](https://travis-ci.org/julie-ng/antwort-cli) [](https://badge.fury.io/rb/antwort)
Author: Julie Ng
Version 1.0.1 (2 July 2017)
### Speed up your email design and development workflow:
- design in code with **live preview** of markup using Antwort's local development server
- **build html** and **inline css** from multiple templates
- **upload images** to content server (S3 only)
- **send email** test via SMTP
- includes **useful helpers**, e.g. `image_tag` that automatically includes email specific markup.
See [CHANGELOG.md](https://github.com/julie-ng/antwort-cli/blob/master/CHANGELOG.md) for full functionality list.
## Documentation
View the API documentation in the wiki:
[https://github.com/julie-ng/antwort-cli/wiki](https://github.com/julie-ng/antwort-cli/wiki)
## Setup
### Requirements
- [Bundler](http://bundler.io/)
- Ruby 2.0+
- AWS S3 Account, for email upload (optional)
- SMTP credentials, for sending test emails (optional)
### Environment
In the project root, create a `.env` file with the following attributes
ASSET_SERVER: https://example.s3.amazonaws.com
AWS_ACCESS_KEY_ID: {{aws_access_key_id}}
AWS_SECRET_ACCESS_KEY: {{aws_secret_access_key}}
AWS_BUCKET: example
FOG_REGION: eu-west-1
SMTP_SERVER: smtp.mandrillapp.com
SMTP_PORT: 587
SMTP_USERNAME: {{username}}
SMTP_PASSWORD: {{password}}
SMTP_DOMAIN: {{domain}}
SEND_TO: {{default_recipient}}
SEND_FROM: {{default_sender}}
See `.env.sample` for an example.
## Use
### Structure
.
+-- .env
+-- build
+-- assets
| +-- css
| +-- images
+-- emails
+-- views
+-- tmp
To create a new email template, for example `newsletter`, simply run: `bundle exec antwort new newsletter` and all the proper files will be created for you.
## Commands
```
Commands:
antwort build EMAIL_ID # Builds email markup and inlines CSS from source
antwort help [COMMAND] # Describe available commands or one specific command
antwort init PROJECT_NAME # Initializes a new Antwort Email project
antwort list # Lists all emails in the ./emails directory by id
antwort new EMAIL_ID # Creates a new email template
antwort prune # Removes all files in the ./build directory
antwort send EMAIL_ID # Sends built email via SMTP
antwort server # Starts http://localhost:9292 server for coding and previewing emails
antwort upload EMAIL_ID # Uploads email assets to AWS S3
antwort version # ouputs version number
```
__Notes__
- You should run the commands prefixed with `bundle exec` to make sure the correct version of gems are used.
## License (MIT)
Copyright (c) 2014-2017 Julie Ng.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.