1.1.7 • Published 3 years ago
obi_emails v1.1.7
This is a HTML email build tool.
Section 1 - How to install.
Step 1
run "node ./node_modules/obi_emails/index.js
Sass file We strongly recommend looking through the sass file to understand how it works. The naming scheme is very intuitive. But it is advisable to become familiar with it if you wish to use it
Component Library To help you get started there is a very useful library of components that are vital in building. Feel free to copy the code and add it to your project. Or if you are stuck on how the layout of HTML emails work then refer to the component library for an idea of how things work :)
Usefull information
You will have a pre-populated sass file called "style.scss" in
a folder called sass - this is a powerful tool that has all the
classes you could need to make your email.
However if you would like to make your own classes feel free
to overwrite it :)
Now you will have a file called dev_email.html - This will be
where you can develop your emails using the classes from the
sass file. When you are finished developing you can take your
inlined (and sass converted) email and save it.
(If you have your own e-mail that you would like to have instead
of the original (and blank) "dev_email.html" file then feel free to
replace the "dev_email.html" file with your own file. Just make sure
that you REPLACE it with the "dev_email.html" file
Also make sure that your new file is ".html)
Nota Bene - it would be advisable to delete the node_modules file as
it takes a lot of space
HAPPY DEVELOPING!