mirror of
https://github.com/resend/react-email.git
synced 2026-09-14 14:18:02 +08:00
Gabriel Miranda
96 lines
1.3 KiB
Plaintext
96 lines
1.3 KiB
Plaintext
---
|
|
title: 'Automatic Setup'
|
|
sidebarTitle: 'Automatic Setup'
|
|
description: 'Add React Email to any JavaScript or TypeScript project in minutes.'
|
|
'og:image': 'https://react.email/static/covers/react-email.png'
|
|
icon: 'download'
|
|
---
|
|
|
|
import NextSteps from '/snippets/next-steps.mdx'
|
|
|
|
<Note>Using monorepos? Then, we recommend following the [monorepo setup](/getting-started/monorepo-setup/choose-package-manager).</Note>
|
|
|
|
## 1. Install
|
|
|
|
We recommend using `create-email`, which sets up everything automatically for you.
|
|
|
|
<CodeGroup>
|
|
|
|
```sh npm
|
|
npx create-email@latest
|
|
```
|
|
|
|
```sh yarn
|
|
yarn create email
|
|
```
|
|
|
|
```sh pnpm
|
|
pnpm create email
|
|
```
|
|
|
|
```sh bun
|
|
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
|
|
npm install
|
|
```
|
|
|
|
```sh yarn
|
|
yarn
|
|
```
|
|
|
|
```sh pnpm
|
|
pnpm install
|
|
```
|
|
|
|
```sh bun
|
|
bun install
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
Then, run the development server:
|
|
|
|
<CodeGroup>
|
|
|
|
```sh npm
|
|
npm run dev
|
|
```
|
|
|
|
```sh yarn
|
|
yarn dev
|
|
```
|
|
|
|
```sh pnpm
|
|
pnpm dev
|
|
```
|
|
|
|
```sh bun
|
|
bun dev
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
## 3. See changes live
|
|
|
|
Visit [localhost:3000](http://localhost:3000) and edit any of the files on the `emails` folder to see the changes.
|
|
|
|
<Frame>
|
|
<img alt="Local Development" src="/images/automatic-setup-dev.png" />
|
|
</Frame>
|
|
|
|
## 4. Next steps
|
|
|
|
<NextSteps/>
|