https://github.com/sinclairnick/brail

💌 Transactional email that feels different
https://github.com/sinclairnick/brail

email-template mail mjml nextjs react typescript

Last synced: 2 months ago
JSON representation

💌 Transactional email that feels different

• Host: GitHub
• URL: https://github.com/sinclairnick/brail
• Owner: sinclairnick
• License: apache-2.0
• Archived: true
• Created: 2022-03-11T02:17:02.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-27T03:30:07.000Z (over 1 year ago)
• Last Synced: 2024-05-01T21:18:58.880Z (8 months ago)
• Topics: email-template, mail, mjml, nextjs, react, typescript
• Language: TypeScript
• Homepage: https://brail.dev
• Size: 4.58 MB
• Stars: 257
• Watchers: 4
• Forks: 6
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-list - brail

README

        
![Brail](./static/banner.jpg)



  

  

  


  


  
Brail

  Quickstart

    •  

  Docs

    •  

  Examples

  


  




Brail provides batteries-included tooling for creating, generating and delivering HTML emails. With out-of-the-box email template correctness, ergonomic React templating and full-stack type-safety, never send an erroneous transactional (or marketing) email again.

## What is Brail?

Brail consists of several tools which aid crafting and delivering emails, across the full-stack:

- [**React Library**](https://www.brail.dev/docs/crafting): Responsive email component library. Compiles to email-compatible HTML

- [**Brail Core**](https://www.brail.dev/docs/using/trpc): Tools for serving emails via type-safe APIs or SDKs

- [**Devtools**](https://www.brail.dev/docs/crafting/devtools): Make email development, debugging and testing easier

- [**Linting**](https://www.brail.dev/docs/crafting/linting): Identify and fix common HTML email pitfalls

## Features

Brail comes packed with many helpful features including:

- 🌈 Theming out-of-the-box

- 📱 Automatic mobile-responsiveness

- 💻 Devtools and live-previews

- ⚠️ Linting

- 🧢 First-class tRPC, Zod integrations

- 🔒 End-to-end type-safety

## Getting started

To get started with Brail, check out the [**Quickstart**](https://www.brail.dev/docs/quick-start) guide.

Alternatively, you can [**check out the Docs**](https://www.brail.dev), try Brail out in a codesandbox or use one of the [**Brail starter projects**](https://github.com/sinclairnick/brail/tree/main/starters):




---




## Why would I want to use Brail?

Handwriting emails using HTML is notoriously a pain. Unlike the web, email clients don't strongly adhere to a specific standard, resulting in limited and inconsistent support for CSS and HTML features.

Consequently, HTML emails become incredibly verbose, complex and littered with Microsoft Outlook-specific HTML comments, heavily nested `` elements and esoteric CSS properties. As such, handwriting HTML email is an uncommon and tedious artform.

Brail abstracts away that complexity and aims to provide a web-like experience to writing emails, making it trivial to produce correct emails.




## Why not use a drag-and-drop editor?

Drag and drop editors make it easy to create email-safe templates, but lack many features we're used to in code-world like theming, abstraction, formatting, maths, version control, PRs and types. By providing a full-proof in-code solution to HTML emails, we regain the control, flexibility and power of code, which makes creating (and refactoring) emails much faster, easier and more fun.