OpenStatus

The Open-Source website & API monitoring platform.
Learn more »

Discord · Website · Issues · Roadmap

About OpenStatus 🏓

OpenStatus is open-source synthetic monitoring platform with beautiful status page and incident management. 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 ping@openstatus.dev

Built with 🛠️

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

Getting Started 🚀

Requirements

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

Setup

1. Clone the repository

   Copy

   1git clone https://github.com/openstatushq/openstatus.git

2. Install dependencies

   Copy

   1pnpm install

3. Set up your .env file

   From apps/web and packages/db, you will find .env.example. Create your own copy.

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

5. Start the development with the below command

   Copy

   1 pnpm dev

   It will:

   • run the web app on port 3000
   • run the api server on port 3001
   • run the docs on port 3002

6. See the results:

• open http://localhost:3000 for the web app
• open http://localhost:3001/ping for the api server health check
• open http://localhost:3002 for the docs

For clerk, you will need to create a webhook endpoint. To access the link, you can use tunneling tools like Tunnelmole, an open source tunnelling tool or ngrok, a popular closed source tunnelling tool.

Using Tunnelmole

1. Install Tunnelmole with curl -O https://install.tunnelmole.com/384HK/install && sudo bash install. (On Windows, download tmole.exe)
2. Run tmole 3000. In the output, you'll see two URLs, one HTTP, and an HTTPS URL. It's best to use the HTTPS URL for privacy and security.

1➜  ~ tmole 3000
2http://bvdo5f-ip-49-183-170-144.tunnelmole.net is forwarding to localhost:3000
3https://bvdo5f-ip-49-183-170-144.tunnelmole.net is forwarding to localhost:3000

Append /api/webhook/clerk to the HTTPs URL.

Using ngrok

After login, append /api/webhook/clerk to the link you get after entering:

1$ ngrok http 3000

Videos

Videos to better understand the OpenStatus codebase:

• The code behind OpenStatus and how it uses Turbopack.
• Drop Betterstack and go open source

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

Stats