Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oddcamp/mrml-rails
Rails ActionMailer Plugin for MRML (Rust version of MJML)
https://github.com/oddcamp/mrml-rails
mjml rails ruby rust
Last synced: about 1 month ago
JSON representation
Rails ActionMailer Plugin for MRML (Rust version of MJML)
- Host: GitHub
- URL: https://github.com/oddcamp/mrml-rails
- Owner: oddcamp
- License: mit
- Created: 2021-02-11T18:15:18.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-24T02:06:11.000Z (over 1 year ago)
- Last Synced: 2024-04-25T09:20:52.161Z (9 months ago)
- Topics: mjml, rails, ruby, rust
- Language: Ruby
- Size: 67.4 KB
- Stars: 16
- Watchers: 6
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Mrml::Rails
`mrml-rails` is a ActionMailer templating engine that uses the Rust-based MRML compiler in order to compile MJML files into pure HTML.
**Minimum Rust version supported is `1.51.0`**
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'mrml-rails'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install mrml-rails
## Usage
All you need to do is to have the file extension `mjml` on the specific views.
I.e.: `sign_up.mjml`, `notification.mjml`
## Development
1. Setup the tools with: `asdf install` (make sure you have the Ruby and Rust asdf plugins installed)
2. Run `bundle install`
3. For rspec run: `bundle exec rspec`
## Heroku Rust Setup
1. Add the rust buildpack to the app (and app.json): `https://buildpack-registry.s3.amazonaws.com/buildpacks/emk/rust.tgz`
2. Add a RustConfig with:
```
VERSION=1.65.0
RUST_SKIP_BUILD=1
```
3. Deploy
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/oddcamp/mrml-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/oddcamp/mrml-rails/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Mrml::Rails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/oddcamp/mrml-rails/blob/master/CODE_OF_CONDUCT.md).