The objective of this GSoC'20 project was to redesign every template listed in System workflow messages and give an enriching prerequisite to an extension that helps in trouble-free customization of templates for both the users and the developers.
In the three months of the coding period, I managed to give a solid foundation to the extension Custom-made, which helps users design decent responsive email templates that are easy to understand and can be written without painful HTML code. And the second part, where I invested a tremendous amount of time, was to redesign more than 25+ predefined templates, so that now every template is entirely responsive and well-sketched with a logo, proper tables, and has added social links to have excellent connectivity while delivering the message.
I have tried to cover up the basic need of this extension.
- Built a complete UI for this extension which covers the making of Page and Form; Page covers the functionality of adding templates, which will have a subject and the feature of editing and deleting template; and on the Form side, establishing a way to input subject and MJML code through pinned text-boxes and returning an HTML code.
- Created a table to hold all the templates.
- Established the API which will convert the MJML code to HTML code.
The extension can be developed in many ways with great functionality in the future. These are some of my thoughts:
- We can have a preview page where users can preview the converted HTML and can make needed changes.
- Auto MJML syntax-completer can be added with error-detecting functionality, which will detect basic errors in MJML syntax while writing code. Creative minds can do wonders with this extension.
All the major demanding subsections of the message templates present in system workflow messages have been thoroughly redesigned with a logo, a better styling element, and some social connective links.
- Templates are built to be responsive and can be viewed through mobiles or devices on different platforms.
- Changed some significant styles, which makes them look more attractive and understandable.
- Pushed some social links to increase the connectivity.
I don't see any work that needs to be done on templates. It is ready to be uploaded, but if anyone feels the need to add something, it would be highly appreciated.
Readme.
Extension.
Preview mjml.
MJML.
- First of all, I would like to express my utmost gratitude towards my mentor Matthew Wire for his kindness and encouraging attitude. He has always been there as a helping hand, was quick with new suggestions and fixes that made me follow the most efficient approach to build our project.
- Thanks to CiviCRM for being an awesome community and painting a positive picture of open source. I would love to be an active member and contributor to CiviCRM in the future.
- Finally, thanks to Google for giving me a great opportunity with GSoC and introducing me to the galaxy of FOSS development. It's hard to believe that I have learned so many things in such a short period. And it feels comforting knowing that I have fetched some excellent skills which will surely help me in the future.
It feels blessed being surrounded by so many talented people.😊