> ## Documentation Index
> Fetch the complete documentation index at: https://vuemail.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Setup

> Things you will need to do beforehand to setup the project

Before you can start developing, you will need to get the project setup.

> [!NOTE]
>
> To contribute to the project, you must use **Node 20.19** or higher.

**1. Clone the repository**

```bash theme={null}
git clone https://github.com/psycarlo/vuemail
```

***

```bash theme={null}
npm install -g pnpm
```

**3. Install all the dependencies**

```bash inside of vuemail theme={null}
pnpm install
```

**4. Build all the packages**

```bash inside of vuemail theme={null}
pnpm build
```

> [!NOTE]
>
> The packages depend on each other's builds, like the demo emails depend on the built `@vuemaildev/vuemail` and
> `@vuemaildev/ui`, so build them once before running tests or the preview.

If you plan to contribute to the docs, view our [Writing docs](https://vuemail.dev/docs/contributing/development-workflow/5-writing-docs.md) guide for additional setup.

If you have any trouble, please [reach out on GitHub Discussions](https://github.com/psycarlo/vuemail/discussions) or consider [opening up an issue on GitHub](https://github.com/psycarlo/vuemail/issues/new?template=1.bug_report.yml) after reading the [issue guidelines](https://vuemail.dev/docs/contributing/opening-issues.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.