Getting Started
- Install node version manager
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.31.4/install.sh | bash- Install and use node version specified from
.nvmrc.
nvm install && nvm use- Install Grunt CLI globally
npm install -g grunt-cli- Install local dependencies
npm install- Install premailer and nokogiri gems
gem install premailer
gem install nokogiriThere are two primary configuration files for MailMason: secrets.json and config.json. By default these files are ignored using .gitignore. Examples of these files are included at example_secrets.json and example_config.json. You can copy these files and rename them to create your own. The specific secrets and configurable values are documented within these files.
If you project is shared among team members, you may want to to update your .gitignore to recognize config.json so that each member of your team isn't forced to recreate it.
By design secrets.json is ignored so that it's not accidentally committed. The base project includes an example_secrets.json that you can copy and rename in order to create your base secrets file. The relevant secrets are documented in the file.
If you're not sending test emails through Postmark and don't want to upload any images to a CDN, you don't have to provide values for these files.
By default, config.json is ignored. The base project includes an example_config.json that you can copy and rename in order to create your base configuration file. The configuration file lets you set a variety of things like product name, sender name, corporate address, and various other strings. Each section and individual option is documented within the example_config.json file.
Postmark doesn't currently provide hosting for images in templates. (It's on our roadmap, though.) So for the time being, if you'd like your emails to use images, you'll need to host these assets somewhere publicly available.
For this reason, images are left off by default. If you turn them on, you'll need to upload the relevant images to a publicly available CDN so they can be displayed in the email.
To do this, you'll need to provide information for your FTP server within config.json and provide the username and password for the FTP server in secrets.json. Once that's complete, you'll be able to upload all images from /src/images to the specified directory on your FTP server.
Once that's done, just add the value for the images_url within the config.json file.
Brought to yousss by
