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

# Installation

> Learn how to install Shootmail in your app.

### Add npmrc file

Add `.npmrc` file in the root directory of your app, with the following content

```bash theme={null}
@shootmail:registry=https://registry.shootmail.app
```

### Login to Shootmail registry

Run `npm login` in your terminal to login to the registry

```bash theme={null}
npm login --registry https://registry.shootmail.app
```

This will prompt you to enter `username` and `password` for the Shootmail registry. This username and password will be provided to you by Shootmail.

### Install Shootmail email builder in your app

Run the following command in your terminal

<CodeGroup>
  ```bash npm theme={null}
  npm install @shootmail/email-builder
  ```

  ```bash pnpm theme={null}
  pnpm add @shootmail/email-builder
  ```
</CodeGroup>

While doing `npm install`, you might get this message:

```
This modules directory was created using the following registries configuration: {"default":"https://registry.npmjs.org/"}. The current configuration is {"default":"https://registry.npmjs.org/","@shootmail":"https://registry.shootmail.app/"}. To recreate the modules directory using the new settings, run "pnpm install".
```

You can safely press `enter` or `Y` to proceed further. This error message notifies you that previously,
all the dependencies were downloaded from the default npm registry, but since now, they will be downloaded
via Shootmail's proxy, the node\_modules folder needs to be re-built. This will not change anything.
