# react-email

**Repository Path**: tpll/react-email

## Basic Information

- **Project Name**: react-email
- **Description**: No description available
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: canary
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-02-06
- **Last Updated**: 2024-02-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![React email cover](https://react.email/static/covers/react-email.png)

<div align="center"><strong>React Email</strong></div>
<div align="center">The next generation of writing emails.<br />High-quality, unstyled components for creating emails.</div>
<br />
<div align="center">
<a href="https://react.email">Website</a> 
<span> · </span>
<a href="https://github.com/resend/react-email">GitHub</a> 
<span> · </span>
<a href="https://react.email/discord">Discord</a>
</div>

## Introduction

A collection of high-quality, unstyled components for creating beautiful emails using React and TypeScript.
It reduces the pain of coding responsive emails with dark mode support. It also takes care of inconsistencies between Gmail, Outlook, and other email clients for you.

## Why

We believe that email is an extremely important medium for people to communicate. However, we need to stop developing emails like 2010, and rethink how email can be done in 2022 and beyond. Email development needs a revamp. A renovation. Modernized for the way we build web apps today.

## Install

Install one of the components from your command line.

#### With yarn

```sh
yarn add @react-email/components -E
```

#### With npm

```sh
npm install @react-email/components -E
```

#### With pnpm

```sh
pnpm install @react-email/components -E
```

## Getting started

Add the component to your email template. Include styles where needed.

```jsx
import { Button } from "@react-email/components";

const Email = () => {
  return (
    <Button href="https://example.com" style={{ color: "#61dafb" }}>
      Click me
    </Button>
  );
};
```

## Components

A set of standard components to help you build amazing emails without having to deal with the mess of creating table-based layouts and maintaining archaic markup.

- [Body](https://github.com/resend/react-email/tree/main/packages/body)
- [Button](https://github.com/resend/react-email/tree/main/packages/button)
- [CodeBlock](https://github.com/resend/react-email/tree/main/packages/code-block)
- [CodeInline](https://github.com/resend/react-email/tree/main/packages/code-inline)
- [Column](https://github.com/resend/react-email/tree/main/packages/column)
- [Container](https://github.com/resend/react-email/tree/main/packages/container)
- [Divider](https://github.com/resend/react-email/tree/main/packages/hr)
- [Font](https://github.com/resend/react-email/tree/main/packages/font)
- [Head](https://github.com/resend/react-email/tree/main/packages/head)
- [Heading](https://github.com/resend/react-email/tree/main/packages/heading)
- [Html](https://github.com/resend/react-email/tree/main/packages/html)
- [Image](https://github.com/resend/react-email/tree/main/packages/img)
- [Link](https://github.com/resend/react-email/tree/main/packages/link)
- [Markdown](https://github.com/resend/react-email/tree/main/packages/markdown)
- [Paragraph](https://github.com/resend/react-email/tree/main/packages/text)
- [Preview](https://github.com/resend/react-email/tree/main/packages/preview)
- [Section](https://github.com/resend/react-email/tree/main/packages/section)

## Integrations

Emails built with React Email can be converted into HTML and sent using any email service provider. Here are some examples:

- [Resend](https://github.com/resend/react-email/tree/main/examples/resend)
- [Nodemailer](https://github.com/resend/react-email/tree/main/examples/nodemailer)
- [SendGrid](https://github.com/resend/react-email/tree/main/examples/sendgrid)
- [Postmark](https://github.com/resend/react-email/tree/main/examples/postmark)
- [AWS SES](https://github.com/resend/react-email/tree/main/examples/aws-ses)

## Support

All components were tested using the most popular email clients.

| <img src="https://react.email/static/icons/gmail.svg" width="48px" height="48px" alt="Gmail logo"> | <img src="https://react.email/static/icons/apple-mail.svg" width="48px" height="48px" alt="Apple Mail"> | <img src="https://react.email/static/icons/outlook.svg" width="48px" height="48px" alt="Outlook logo"> | <img src="https://react.email/static/icons/yahoo-mail.svg" width="48px" height="48px" alt="Yahoo! Mail logo"> | <img src="https://react.email/static/icons/hey.svg" width="48px" height="48px" alt="HEY logo"> | <img src="https://react.email/static/icons/superhuman.svg" width="48px" height="48px" alt="Superhuman logo"> |
| -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| Gmail ✔                                                                                           | Apple Mail ✔                                                                                           | Outlook ✔                                                                                             | Yahoo! Mail ✔                                                                                                | HEY ✔                                                                                         | Superhuman ✔                                                                                                |

## Development

#### Install dependencies

```sh
pnpm install
```

#### Build and run packages

```sh
pnpm dev
```

This will initialize all packages in parallel and watch for changes, including the website which will be available at [localhost:3000](http://localhost:3000).

## Contributing

- [Contribution Guide](https://react.email/docs/contributing)

## Authors

- Bu Kinoshita ([@bukinoshita](https://twitter.com/bukinoshita))
- Zeno Rocha ([@zenorocha](https://twitter.com/zenorocha))

## License

MIT License