/openstatus

πŸ“ The open-source monitoring platform with incident management πŸ“

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

OpenStatus

The Open-Source monitoring platform with incident management.
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

Book us with Cal.com

Built with πŸ› οΈ

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.

  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:

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