Skip to content

openstatusHQ/openstatus

Repository files navigation

OpenStatus

The Open-Source synthetic monitoring platform.
Learn more Β»

Discord Β· Website Β· Issues

About OpenStatus πŸ“

OpenStatus is open-source synthetic monitoring monitoring platform.

  • Synthetic monitoring: Monitor your website and APIs globally and receive notifications when they are down or slow.

Recognitions πŸ†

openstatusHQ%2Fopenstatus | Trendshift

Featured on Hacker News

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

Book us with Cal.com

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

Alt

Tech stack πŸ₯ž

Built with Depot

Getting Started πŸš€

Requirements

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 copy.

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

  5. Start the development with the below command

     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:

Videos

Videos to better understand the OpenStatus codebase: