README.md

The Open-Source Synthetic Monitoring Platform with Incident Management

The Open-Source Serverless monitoring platform.
Learn more »

Discord · Website · Issues · Roadmap

About OpenStatus

OpenStatus is open-source synthetic monitoring platform with beautiful status page. We are building it publicly for everyone to see our progress. We believe great softwares are built this way.

You can choose to host it yourself or use our hosted version at openstatus.dev

Contact us

If you want to learn more about this project or have any questions, book a call with us or send us an email at [email protected]

Built with

• Next.js
• Tailwind CSS
• shadcn/ui
• tinybird
• turso
• drizzle
• clerk
• Resend

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

   from apps/web and packages/db you will find .env.example create your own.

4. Follow the steps to run your sqlite database locally inside of README.md

5. Start the development server

    pnpm dev

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

For clerk, you will need to create a webhook endpoint. To access the link via ngrok (free), after login, append /api/webhook/clerk to the link you get after entering:

$ ngrok http 3000

Videos

Videos to better understand the OpenStatus codebase:

• The code behind OpenStatus and how it uses Turbopack.

Roadmap

Here's our roadmap feel free to contribute to it.

Contributing

If you want to help us building the best status page and alerting system, you can check our contributing guidelines

Top Contributors

Made with Contrib.rocks