TidyStatus/
TIDYSTATUS / DOCS

A tidy place to start.

The project, the moving parts, and what to know before running your own status page.

Introduction

TidyStatus is an open-source status-page project for publishing service health, uptime history, and incident updates. This site is the project website — it doesn't host your status page or offer accounts.

A note about the source

The canonical GitHub repository hasn't been linked yet. GitHub buttons open a search for TidyStatus. Confirm the correct repository and follow its README for the definitive installation steps and license.

Getting started

  1. Get the source. Find the TidyStatus repository on GitHub and clone or download it.
  2. Check the prerequisites. The current project uses TypeScript, React, TanStack Start, and Tailwind CSS. Use the package manager and runtime versions specified by the repository.
  3. Install and run locally. From your checkout, install dependencies and start the development server.
Terminal
# From your local TidyStatus checkout
npm install
npm run dev

These commands start the development environment; they do not provision a database or configure email. Set up those dependencies before running a functional status-page deployment.

Configuration

The status-page application uses a database for services, incidents, updates, and daily uptime. The current implementation uses a Supabase-compatible client and role-protected owner access. The project website does not read or write that data.

SettingPurpose
Brand & domainYour product name, logo, and status-page address.
Database connectionYour own database, schema, and access policies.
Owner accessAn authenticated owner who can update service health and incidents.
Email provider (optional)Your sender identity and server-side credentials for Resend.

Use the source repository's environment-variable instructions. Keep private keys on the server, never in browser code or a public repository.

Services & uptime

Group your own services separately from third-party infrastructure. Each component has a name, description, display order, and one of four states:

  • Operational — working normally.
  • Degraded — working, but not at full capacity.
  • Outage — unavailable.
  • Maintenance — planned work in progress.

The status-page implementation displays 60-day uptime history and refreshes status data every 30 seconds. It is not an automatic monitoring agent: provide daily uptime records and service-state updates from your own workflow or monitoring integration.

The interactive example on the homepage uses local sample data only.

Incident workflow

An incident connects a title, severity, affected services, and a sequence of updates. Keep messages short and useful: what changed, who is affected, and what happens next.

InvestigatingIdentifiedMonitoringResolved

Post updates as you learn more, then resolve the incident when service is restored. Planned work can be reported as maintenance. The current owner interface supports creating incidents, posting updates, and managing service states.

Notifications

The source includes email subscriptions, token-based unsubscribe links, and owner-authorized broadcasts using Resend. Email is optional and requires your own provider credentials and verified sender setup.

No subscriber sign-up is available on this project website. In your own deployment, subscriber addresses must remain private, and broadcasts must be limited to authorized owners. Check email delivery and unsubscribe behavior before inviting subscribers.

Deployment

Run your instance on infrastructure that supports the repository's TanStack Start build. The current template targets an edge runtime; a static file host alone cannot run database administration or email functions.

  • Apply the repository's schema and access policies to your own database.
  • Configure owner authentication and verify access restrictions.
  • Store provider secrets in your hosting environment.
  • Connect your domain and enable HTTPS.
  • Test service changes, incident resolution, and optional email delivery.
  • Plan backups, updates, and monitoring for the status page itself.
Self-hosted means self-managed.

Hosting, database, and email providers may charge for their services. TidyStatus does not supply managed hosting, uptime guarantees, or automatic deployment.

Contributing

Report reproducible bugs, propose focused improvements, or help make the documentation clearer. Check the repository's issue tracker and contribution guide before opening a pull request.

Review the repository license for the terms that apply to use, modification, and distribution.

Find on GitHub