1. Documentation
  2. Introduction
ReadmeGitHub
  • Introduction
  • Quickstart
  • CLI
  • Configuration
  • Identity
  • Branding
  • Themes
  • Monitors
  • Checks and scheduling
  • Metrics and badges
  • Incidents
  • Maintenance
  • Notifications
  • Subscribers
  • React Router
  • Next.js
  • Astro
  • SQLite
  • Cloudflare D1
  • PostgreSQL
  • Schema and migrations
  • Cloudflare
  • Vercel
  • Self-hosting
  • API overview
  • Status endpoints
  • Incident endpoints
  • Maintenance endpoints
  • Subscriber endpoints
  • Badges, feeds and metrics
  • Admin endpoints
  • The check run
  • Uptime and history
  • Automatic incidents
  • Notification delivery
  • Public subscriptions

Introduction

Heyo Status is a themeable, TypeScript-first status page for React Router, Next.js and Astro.

Heyo Status gives you a status page in your own app. It checks your services, keeps uptime history and publishes incidents and planned maintenance. You can also send updates to your team and subscribers. The page, API and scheduler share one heyo-status.config.ts file.

To get a page running, use create-heyo-status. The generator supplies the framework routes, database adapter and deployment scheduler together; installing the runtime package alone does not produce a working status page. Then replace the example monitors and choose a theme. Visitors can read the server-rendered page without JavaScript.

heyo-sh/heyo-status

Loading repository data…

——

Choose a framework

Pick the framework you use. Each starter exposes the same status API and reads the same configuration file.

React Router

Render a live status page with Framework Mode loaders and actions.

Next.js

Serve a fresh snapshot with Next.js App Router route handlers.

Astro

Build an Astro page with a live API and an interactive React island.

Once the page is running, set your check schedule and deploy to Cloudflare, Vercel, or your own server.

QuickstartNext >

Powered by heyo

On this page

Choose a framework