AiO email creator assitant
Your project need NodeJS 8+.
Postally are using the following libraries to offer an full email development environment :
- πΎ Twig.js as the main template engine
- π Inky as the Email template engine
- βοΈ Foundation for Emails as HTML/CSS framework
To help your Email creation process, you can take a look at :
- Twig documentation
- Foundation for Emails documentation
- Inky templates examples
- Available Sass variables
First, install postally globally
$ npm install -g postally
# or
$ yarn global add postally
To create a new postally project, you can choose to create a new directory (f.ex. new_project
) or bootstrap the project inside the current one.
$ postally init new_project
$ cd new_project
# or
$ postally init
This will produce the following file structure inside your project directory :
.
βββ build π your project's build (to use with MailChimp or CM)
βββ data.json π the json data to inject in the markup
βββ images π your image folder
βββ index.html π the inky/twig newsletter template
βββ node_modules π your only dependency
β βββ foundation-emails
βββ package-lock.json
βββ package.json π npm settings
βββ styles.scss π your custom styles
βββ variables.scss π your custom and overrided Foundation for Emails variables
In your project directory, you can use the following command to start a web server into your default browser. It will automaticaly reload the rendered page and remake the build each time you will save your working files.
$ postally start
Almost the same as the start command, it only creates a once build.
$ postally build