mailing/README.md

Fun email development environment

<img src="https://user-images.githubusercontent.com/609038/206747937-74206c35-0587-4a2f-a744-126ea356756f.png#gh-dark-mode-only" alt="Mailing logo" width="295" height="64"/>
<img src="https://user-images.githubusercontent.com/609038/206747927-112e3d23-e5e6-4f7c-950b-4490b7c4bbe8.png#gh-light-mode-only" alt="Mailing logo" width="295" height="64"/>

<a href="https://www.npmjs.com/package/mailing"><img src="https://img.shields.io/npm/v/mailing.svg?sanitize=true" alt="Version"></a>
[![Featured on Openbase](https://badges.openbase.com/js/featured/mailing.svg?token=A6xfdFmUU161m5Jns1Aqf4SwwIMSQBipWCm7HCdl1wc=)](https://openbase.com/js/mailing?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge)
[![](https://dcbadge.vercel.app/api/server/fdSzmY46wY?style=flat)](https://discord.gg/fdSzmY46wY)

<h2>●&nbsp;&nbsp;Build, test, send emails with React</h2>

- Build email templates with React components [Examples](https://www.mailing.run/docs/templates)
- MJML components that work across clients (Outlook!)
- Preview server with live reload for quick development
- Dev mode opens emails in your browser instead of sending
- Test mode for ensuring emails send and have the correct content
- Plays well with js frameworks like next.js, redwood.js, remix
- Written in TypeScript, inspired by Action Mailer from Ruby on Rails

<br/>

## ●&nbsp;&nbsp;Why?

We’re longtime users of Action Mailer and wanted something similar for our typescript/react apps. We didn’t find anything, so we decided to build Mailing. We added some features that we would’ve liked in Action Mailer, like a mobile toggle (with hotkeys), and the ability to send a test email from the browser while developing. We went all in on MJML so that we (almost) never have to think about email clients or nested tables :)

<br/>

## ●&nbsp;&nbsp;Get started

Prerequisites: Mailing requires version 16+ of node and running on Mac or Linux. Windows is not supported at this time, but we'd welcome a pull request to [fix these bugs](https://github.com/sofn-xyz/mailing/issues/187) and add Windows support!

To get started with Mailing, check out the [official docs](https://www.mailing.run/docs).

<br/>

## ●&nbsp;&nbsp;&nbsp;Contributing

Want to improve Mailing? Incredible. Try it out, file an issue or open a PR.

Check the [CONTRIBUTING.md](https://github.com/sofn-xyz/mailing/blob/main/docs/CONTRIBUTING.md) for more info.

<br/>

## ●&nbsp;&nbsp;&nbsp;Support

Need help getting set up? Hit us up on discord [![](https://dcbadge.vercel.app/api/server/fdSzmY46wY?style=flat)](https://discord.gg/fdSzmY46wY)