mirror of
https://github.com/resend/react-email.git
synced 2026-09-14 14:18:02 +08:00
cpenned
25753037cd
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
44 lines
1.6 KiB
Plaintext
44 lines
1.6 KiB
Plaintext
---
|
|
title: 'Setup'
|
|
sidebarTitle: '1. Setup'
|
|
'og:image': 'https://react.email/static/covers/react-email.png'
|
|
description: 'Things you will need to do beforehand to setup the project'
|
|
---
|
|
|
|
Before you can start developing, you will need to get the project setup.
|
|
|
|
<Info>
|
|
To contribute to the project, you must use **Node 18** or higher.
|
|
</Info>
|
|
|
|
<Steps>
|
|
<Step title="Clone the repository">
|
|
```bash
|
|
git clone https://github.com/resend/react-email
|
|
```
|
|
</Step>
|
|
<Step title={<>Enable <a href="https://pnpm.io/">pnpm</a> through <a href="https://github.com/nodejs/corepack">corepack</a></>}>
|
|
```bash inside of react-email
|
|
corepack enable
|
|
corepack prepare pnpm@latest --activate
|
|
```
|
|
</Step>
|
|
<Step title="Install all the dependencies">
|
|
```bash inside of react-email
|
|
pnpm install
|
|
```
|
|
</Step>
|
|
<Step title="Link email-dev CLI globally">
|
|
```bash inside of react-email
|
|
pnpm link ./packages/react-email/dev -g
|
|
```
|
|
<Note>
|
|
Linking the CLI globally runs the CLI's source code when you use the `email-dev` command, avoiding the need to rebuild the CLI.
|
|
</Note>
|
|
</Step>
|
|
</Steps>
|
|
|
|
If you plan to contribute to the docs, view our [Writing docs](/contributing/development-workflow/5-writing-docs) guide for additional setup.
|
|
|
|
If you have any trouble, please [reach out on GitHub Discussions](https://github.com/resend/react-email/discussions) or consider [opening up an issue on GitHub](https://github.com/resend/react-email/issues/new?assignees=&labels=Type%3A+Bug&projects=&template=1.bug_report.yml) after reading the [issue guidelines](/contributing/opening-issues).
|