Skip to main content

5-Minute Quickstart

Get AlertifyPro up and running and monitoring your first service.

Step 1: Start the backend​

cd backend
cp .env.example .env
# Edit .env: set JWT_SECRET and ENCRYPTION_KEY before starting

docker compose up -d   # starts PostgreSQL, Redis, API, scheduler, notification worker
make db-init           # apply database schema

The API is available at http://localhost:3001.

curl http://localhost:3001/api/v1/health
# OK

Step 2: Start the frontend dashboard​

cd frontend
npm install
npm run dev
# Dashboard at http://localhost:3000

Step 3: Create your account​

curl -X POST http://localhost:3001/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "your_password",
    "full_name": "Your Name"
  }'

This creates your user account and an organization (free plan, up to 5 services).

Step 4: Log in and get your token​

curl -X POST http://localhost:3001/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "your_password"
  }'

Copy the token from the response — you'll need it for all subsequent requests.

export WK_TOKEN="eyJhbGci..."

Step 5: Add your first service to monitor​

curl -X POST http://localhost:3001/api/v1/services \
  -H "Authorization: Bearer $WK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Website",
    "endpoint": "https://example.com",
    "check_type": "HTTP",
    "check_interval_seconds": 60
  }'

AlertifyPro will begin checking https://example.com every 60 seconds. Check results show as GREEN, YELLOW, or RED.

Step 6: View results in the dashboard​

Open http://localhost:3000 in your browser, log in with your credentials, and you'll see your service status on the dashboard.

What to do next​