Awesome
<p align="center" style="margin-top: 120px"> <h3 align="center">OpenStatus</h3> <p align="center"> <a href="https://status.openstatus.dev"> <img src='https://status.openstatus.dev/badge'> </a> </p> <p align="center">The Open-Source synthetic monitoring platform. <br /> <a href="https://www.openstatus.dev"><strong>Learn more Β»</strong></a> <br /> <br /> <a href="https://www.openstatus.dev/discord">Discord</a> Β· <a href="https://www.openstatus.dev">Website</a> Β· <a href="https://github.com/openstatushq/openstatus/issues">Issues</a> </p> </p>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 π
<a href="https://trendshift.io/repositories/1780" target="_blank"><img src="https://trendshift.io/api/badge/repositories/1780" alt="openstatusHQ%2Fopenstatus | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
<a href="https://news.ycombinator.com/item?id=37740870"> <img alt="Featured on Hacker News" src="https://hackerbadge.now.sh/api?id=37740870" style="width: 250px; height: 55px;" width="250" height="55" /> </a>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<br/><br/> <a href="https://cal.com/team/openstatus/30min"><img alt="Book us with Cal.com" src="https://cal.com/book-with-cal-dark.svg" /></a>
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
<a href="https://github.com/openstatushq/openstatus/graphs/contributors"> <img src="https://contrib.rocks/image?repo=openstatushq/openstatus" /> </a>Made with Contrib.rocks
Stats
Tech stack π₯
Getting Started π
Requirements
Setup
-
Clone the repository
git clone https://github.com/openstatushq/openstatus.git
-
Install dependencies
pnpm install
-
Set up your .env file
From
apps/web
andpackages/db
, you will find .env.example. Create your own copy. -
Follow the steps to run your sqlite database locally inside of README.md
-
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
- run the web app on port
-
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
Videos
Videos to better understand the OpenStatus codebase: