Setting up for yarn workspaces

This is a guide intended at users of yarn modern. For those who are using yarn classic (1.x), you can do something similar to the pnpm guide.

1. Create transactional workspace

Create a new folder called transactional inside of where you keep workspace packages (generally ./packages/*). Include a new package.json and do not forget to add this to the workspaces of your monorepo’s package.json.

React Email + Turborepo + yarn example

See the full source code

2. Set linker either to `node-modules` or to `pnpm`

Currently, React Email can only work with yarn’s node-modules and pnpm install modes so you will need to set it to one of these two on your .yarnrc.yml file:

.yarnrc.yml

nodeLinker: node-modules

3. Install dependencies

Install React Email in the transactional workspace.

packages/transactional

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

4. Add scripts

Include the following script in your package.json file.

packages/transactional/package.json

{
  // ...
  "scripts": {
    "dev": "email dev"
  }
  // ...
}

5. Write your emails

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

packages/transactional/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>
  );
}

6. Run preview server

Start the email previews development server:

packages/transactional

yarn dev

7. See changes live

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

8. Try it yourself

React Email + Turborepo + yarn example

See the full source code

​1. Create transactional workspace

React Email + Turborepo + yarn example

​2. Set linker either to node-modules or to pnpm

​3. Install dependencies

​4. Add scripts

​5. Write your emails

​6. Run preview server

​7. See changes live

​8. Try it yourself

React Email + Turborepo + yarn example

1. Create transactional workspace

2. Set linker either to `node-modules` or to `pnpm`

3. Install dependencies

4. Add scripts

5. Write your emails

6. Run preview server

7. See changes live

8. Try it yourself