> ## 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.

# Automatic Setup

> Add Vuemail to any JavaScript or TypeScript project in minutes.

> [!NOTE]
>
> Using monorepos? Then, we recommend following the [monorepo setup](https://vuemail.dev/docs/getting-started/monorepo-setup/choose-package-manager).

## 1. Install

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

```sh npm theme={null}
npx create-vuemail@latest
```

```sh yarn theme={null}
yarn create vuemail
```

```sh pnpm theme={null}
pnpm create vuemail
```

```sh bun theme={null}
bun create vuemail
```

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

## 2. Run locally

First, install the dependencies:

```sh npm theme={null}
npm install
```

```sh yarn theme={null}
yarn
```

```sh pnpm theme={null}
pnpm install
```

```sh bun theme={null}
bun install
```

Then, run the development server:

```sh npm theme={null}
npm run dev
```

```sh yarn theme={null}
yarn dev
```

```sh pnpm theme={null}
pnpm dev
```

```sh bun theme={null}
bun dev
```

## 3. See changes live

Visit [localhost:3000](http://localhost:3000) and edit any of the files on the `emails` folder to see the changes.

![Local Development](https://mintcdn.com/vuemail/ub4RJR7qi6Nze3pN/images/automatic-setup-dev.png?fit=max\&auto=format\&n=ub4RJR7qi6Nze3pN\&q=85\&s=aac29c2cb0a7af52614480eadfaec842)

## 4. Next steps

Try adding these other components to your email.

> **[Image](https://vuemail.dev/docs/components/image.md)**
>
> Display an image in your email.

> **[Link](https://vuemail.dev/docs/components/link.md)**
>
> A hyperlink to web pages or anything else a URL can address.

> **[Divider](https://vuemail.dev/docs/components/hr.md)**
>
> Display a divider that separates content areas in your email.

> **[Preview](https://vuemail.dev/docs/components/preview.md)**
>
> A preview text that will be displayed in the inbox of the recipient.


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