The Open-source Status Page and Alerting System

The OpenStatus project is a free and open-source alternative to Statuspage. It provides a status page and alerting system that can be used to keep users informed about the status of services or systems.

About this project

OpenStatus is a community-driven project aimed at providing a reliable and customizable solution for managing status pages and alerts. It is built using Next.js, Tailwind CSS, shadcn/ui, tinybird, planetscale, drizzle, clerk, and Resend.

Contributing

Details about how to contribute to the project will be available soon.

Contact us

If you have any questions or would like to learn more about this project, you can reach us via email at hello@openstatus.dev.

Getting Started

Requirements

• Node.js >= 18.0.0
• pnpm >= 8.6.2

Setup

1. Clone the repository: git clone https://github.com/openstatushq/openstatus.git
2. Install dependencies: pnpm install
3. Set up your .env file: create your own .env file based on the provided examples in apps/web and packages/db directories
4. Start the development server: pnpm dev

Open http://localhost:3000 in your browser to see the result.

To use Clerk, you'll need to create a webhook endpoint. You can access the link via ngrok (free). After logging in, append "/api/webhook/clerk" to the link you receive after entering the following command:

$ ngrok http 3000

Roadmap

Contributors are welcome to contribute to our roadmap.

Contributors