Back to Templates

OpenStatus.dev

OpenStatus is an open source alternative to your current monitoring service with a beautiful status page.

Written by
mxkaske, thibaultleouay
Framework
Next.js
Language
Typescript
OpenStatus is an open source alternative to your current monitoring service with a beautiful status page.

OpenStatus

The Open-Source performance monitoring platform.
Learn more »

Discord · Website · Issues · Roadmap

About OpenStatus 🏓

OpenStatus is open-source performance monitoring platform.

  • Synthetic monitoring: Monitor your website and APIs worldwide and receive notifications when they are down or slow.
  • Real User Monitoring: Understand how your users are experiencing your website with core web vitals metrics.

Recognitions 🏆

Contact us 💌

If you are interested in our enterprise plan or need special features, please email us at ping@openstatus.dev or book a call

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

Built with 🛠️

Getting Started 🚀

Requirements

Setup

  1. Clone the repository

    1git clone https://github.com/openstatushq/openstatus.git
  2. Install dependencies

    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

    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:

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

Videos

Videos to better understand the OpenStatus codebase:

Protect your API.
Start today.

2500 verifications and 100K successful rate‑limited requests per month. No CC required.