Back to React Email

Automatic Setup

apps/docs/getting-started/automatic-setup.mdx

0.0.151.1 KB
Original Source

import NextSteps from '/snippets/next-steps.mdx'

<Note>Using monorepos? Then, we recommend following the monorepo setup.</Note>

1. Install

We recommend using create-email, which sets up everything automatically for you.

<CodeGroup>
sh
npx create-email@latest
sh
yarn create email
sh
pnpm create email
sh
bun create email
</CodeGroup>

This will create a new folder called react-email-starter with a few email templates.

2. Run locally

First, install the dependencies:

<CodeGroup>
sh
npm install
sh
yarn
sh
pnpm install
sh
bun install
</CodeGroup>

Then, run the development server:

<CodeGroup>
sh
npm run dev
sh
yarn dev
sh
pnpm dev
sh
bun dev
</CodeGroup>

3. See changes live

Visit localhost:3000 and edit any of the files on the emails folder to see the changes.

<Frame> </Frame>

4. Next steps

<NextSteps/>