Git Product home page Git Product logo

muil's Introduction

Muil

Muil is a framework to build, maintain, and manage dynamic email, PDF, and image templates using React

Why Muil

  1. Solutions like MJML or Foundation for Emails require your team to learn whole new custom languages, which can be tedious and time-consuming. With Muil, you can build templates using React and tools you already know and love!

  2. Take full advantage of React’s declarative and component-based nature which makes coding reusable, fast, simple, and easy to maintain. Our smart platform is designed to significantly improve your ability to cut down on boilerplate and enforce best practices into your work, so you are equipped with the tools and tricks you need to build complex templates faster.

  3. While other solutions require that you build and manage a service to render templates, Our free templates render service (app.muil.io) eliminates these concerns. This makes getting started with template development easier, more intuitive, and developer-friendly.

  4. When developing emails, it’s vital to ensure templates are compatible across email clients. Muil’s comprehensive library features ready-made, responsive components including charts, buttons, menus, block grids, typography, and more that help you steer clear from complex table markup and inconsistent results.

  5. When developing emails, it’s vital to make templates small. Muil automatically stores images in the cloud, inline styles, and minify code.

  6. Building dynamic PDF and generating it on the server side is incredibly challenging. Muil lets you take advantage of React and all the other tools you feel comfortable using, so you can build complex PDF templates just as easily as you build Web Apps! With Muil, building dynamic email templates has never been so simple!

Documentation

Muil Docs

Installation

yarn install

Usage

Set the following environment variables

ADMIN_USERNAME=
ADMIN_PASSWORD=
SECRET=
CORS_ORIGIN=
PUPPETEER_EXECUTABLE_PATH=

Run the service

yarn start

Available environment variables

Environment Variables Description
HTTP_SECURE Use secure authentication cookies
SECRET Authentication token secret
HOST_NAME Service hostname / FQDN
DATABASE_URL SQLite Database file location
ADMIN_USERNAME Default admin username (will be created on service first run)
ADMIN_PASSWORD Default admin password
TEMPLATES_DIRECTORY The templates directory
SMTP_DEFAULT_FROM Email will be sent with this from email address
SMTP_HOST SMTP Server host
SMTP_PORT SMTP Server port
SMTP_SECURE SMTP Server secure
SMTP_USER SMTP Server user
SMTP_PASS SMTP Server password
CORS_ORIGIN List of allowed cors origin hosts
PUPPETEER_EXECUTABLE_PATH Path to chrome or firefox executable

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

muil's People

Contributors

nir-ne avatar nir905 avatar shahafa avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.