Skip to main content

Documentation Index

Fetch the complete documentation index at: https://react.email/docs/llms.txt

Use this file to discover all available pages before exploring further.

Before you can start developing, you will need to get the project setup.
To contribute to the project, you must use Node 18 or higher.
1

Clone the repository

git clone https://github.com/resend/react-email
2

Enable pnpm through corepack

inside of react-email
corepack enable
corepack prepare pnpm@latest --activate
3

Install all the dependencies

inside of react-email
pnpm install
4

Link email-dev CLI globally

inside of react-email
pnpm link ./packages/react-email/dev -g
Linking the CLI globally runs the CLI’s source code when you use the email-dev command, avoiding the need to rebuild the CLI.
If you plan to contribute to the docs, view our Writing docs guide for additional setup. If you have any trouble, please reach out on GitHub Discussions or consider opening up an issue on GitHub after reading the issue guidelines.