https://github.com/sofn-xyz/mailing

Build, test, send emails with React
https://github.com/sofn-xyz/mailing

Last synced: 4 days ago
JSON representation

Build, test, send emails with React

• Host: GitHub
• URL: https://github.com/sofn-xyz/mailing
• Owner: sofn-xyz
• License: mit
• Created: 2022-04-10T17:54:52.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-27T09:36:53.000Z (8 months ago)
• Last Synced: 2024-12-31T00:08:06.089Z (11 days ago)
• Language: TypeScript
• Homepage: https://www.mailing.run
• Size: 26.7 MB
• Stars: 3,613
• Watchers: 8
• Forks: 71
• Open Issues: 58
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-list - mailing - xyz | 3612 | (TypeScript)
• awesome - sofn-xyz/mailing - Build, test, send emails with React (TypeScript)
• awesome-github-repos - sofn-xyz/mailing - Build, test, send emails with React (TypeScript)

README

        






[![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)

●  Build, test, send emails with React


- 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




## ●  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 :)




## ●  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).




## ●   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.




## ●   Support

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