> ## Documentation Index
> Fetch the complete documentation index at: https://monitor-f3599674.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Create your first monitor and status page in minutes

<Info>
  **Prerequisites**

  * Node.js version 19 or higher
  * A running MongoDB instance (local or [MongoDB Atlas](https://www.mongodb.com/atlas))
  * A [Resend](https://resend.com) API key (or SMTP credentials) for email alerts
</Info>

## Step 1: Clone and install

```bash theme={null}
git clone https://github.com/aevrHQ/monitor.git
cd monitor/monitor-web
npm install
```

## Step 2: Configure environment variables

Copy the example env file and fill in your values:

```bash theme={null}
cp .env.example .env
```

Key variables to set:

| Variable              | Description                                    |
| --------------------- | ---------------------------------------------- |
| `MONGODB_URI`         | MongoDB connection string                      |
| `SESSION_SECRET`      | Long random string used to sign sessions       |
| `RESEND_API_KEY`      | Resend API key for email alerts                |
| `NEXT_PUBLIC_APP_URL` | Public base URL (e.g. `http://localhost:9100`) |

## Step 3: Start the development server

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

The app runs on **port 9100** by default. Open [http://localhost:9100](http://localhost:9100) in your browser.

## Step 4: Create an account

1. Go to [http://localhost:9100/register](http://localhost:9100/register).
2. Enter your email address and a password.
3. Verify your email via the OTP sent to your inbox.

An organization is automatically created for your account on first sign-in.

## Step 5: Create your first monitor

1. In the sidebar, click **Monitors**.
2. Fill in the monitor form:
   * **Monitor name** — e.g. `API health`
   * **URL** — e.g. `https://api.example.com/health`
   * **Check type** — `Endpoint` (HTTP status check)
   * **Interval** — `5` minutes
3. Click **Next**, review the check settings, then click **Create Monitor**.

<Tip>
  Enable **Show on public status page** to surface monitor health on your organization's public status page at `/status/{slug}`.
</Tip>

## Step 6: Add an alert channel

1. In the sidebar, click **Alerts**.
2. Choose a channel type — Email, Slack, Discord, or Webhook.
3. Fill in the required configuration and click **Add Channel**.

Your team will now receive notifications when a monitor changes state.

## Next Steps

<CardGroup cols={2}>
  <Card title="Monitors" icon="activity" href="/features/monitors">
    Explore all check types and advanced configuration options.
  </Card>

  <Card title="Status Pages" icon="globe" href="/features/status-pages">
    Customize and publish your public status page.
  </Card>

  <Card title="Incidents" icon="siren" href="/features/incidents">
    Learn how to create and manage incidents.
  </Card>

  <Card title="Alert Channels" icon="bell-ring" href="/features/alert-channels">
    Configure Slack, Discord, and webhook notifications.
  </Card>
</CardGroup>