Manual Setup - React Email

Are you using monorepos? Then we recommend you follow our monorepos setup.

1. Install dependencies

Install the React Email packages locally.

npm install @react-email/ui -D -E
npm install react-email react react-dom -E

yarn add @react-email/ui -D -E
yarn add react-email react react-dom -E

pnpm add @react-email/ui -D -E
pnpm add react-email react react-dom -E

bun add @react-email/ui -D -E
bun add react-email react react-dom -E

2. Add scripts

Include the following script in your package.json file.

package.json

{
  "scripts": {
    "email:dev": "email dev"
  }
}

3. Write an email template

Create a new folder called emails, create a file inside called email.tsx, and add the following code:

emails/email.tsx

import { Button, Html, Head, Body } from "react-email";
import * as React from "react";

export default function Email() {
  return (
    <Html>
      <Head />
      <Body>
        <Button
          href="https://example.com"
          style={{ background: "#000", color: "#fff", padding: "12px 20px" }}
        >
          Click me
        </Button>
      </Body>
    </Html>
  );
}

4. Run locally

Start the development server.

npm run email:dev

yarn email:dev

pnpm email:dev

bun email:dev

5. See changes live

Visit localhost:3000 and edit email.tsx file to see the changes.

6. Next steps

Try adding these other components to your email.

Image

Display an image in your email.

Link

A hyperlink to web pages or anything else a URL can address.

Divider

Display a divider that separates content areas in your email.

Preview

A preview text that will be displayed in the inbox of the recipient.

​1. Install dependencies

​2. Add scripts

​3. Write an email template

​4. Run locally

​5. See changes live

​6. Next steps

Image

Link

Divider

Preview

1. Install dependencies

2. Add scripts

3. Write an email template

4. Run locally

5. See changes live

6. Next steps