Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openstatushq/openstatus
🏓 The open-source website & API monitoring platform 🏓
https://github.com/openstatushq/openstatus
bun clerk drizzle-orm monitoring nextjs nextjs13 observability on-call open-source shadcn-ui status-page synthetic-monitoring tinybird turso
Last synced: about 1 month ago
JSON representation
🏓 The open-source website & API monitoring platform 🏓
- Host: GitHub
- URL: https://github.com/openstatushq/openstatus
- Owner: openstatusHQ
- License: agpl-3.0
- Created: 2023-06-19T15:32:41.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-12T22:22:41.000Z (5 months ago)
- Last Synced: 2024-04-14T06:44:59.445Z (5 months ago)
- Topics: bun, clerk, drizzle-orm, monitoring, nextjs, nextjs13, observability, on-call, open-source, shadcn-ui, status-page, synthetic-monitoring, tinybird, turso
- Language: TypeScript
- Homepage: https://openstatus.dev
- Size: 13.9 MB
- Stars: 3,975
- Watchers: 17
- Forks: 209
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.MD
- License: LICENSE
Awesome Lists containing this project
README
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 [[email protected]](mailto:[email protected]) or book a
call
## Roadmap 🗺️
Here's our [roadmap](https://openstatus.productlane.com/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](https://github.com/openstatusHQ/openstatus/blob/main/CONTRIBUTING.MD)
### Top Contributors
Made with [Contrib.rocks](https://contrib.rocks)
### Stats
## Tech stack 🥞
- [Next.js](https://nextjs.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [shadcn/ui](https://ui.shadcn.com/)
- [tinybird](http://tinybird.co/?ref=openstatus.dev)
- [turso](http://turso.tech/)
- [drizzle](https://orm.drizzle.team/)
- [Resend](https://resend.com/)
[](https://depot.dev/?utm_source=Opource=OpenStatus)
## Getting Started 🚀
### Requirements
- [Node.js](https://nodejs.org/en/) >= 20.0.0
- [pnpm](https://pnpm.io/) >= 8.6.2
### Setup
1. Clone the repository
```sh
git clone https://github.com/openstatushq/openstatus.git
```
2. Install dependencies
```sh
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](https://github.com/openstatusHQ/openstatus/blob/main/packages/db/README.md)
5. Start the development with the below command
```sh
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](http://localhost:3000) for the web app
- open [http://localhost:3001/ping](http://localhost:3001/ping) for the api
server health check
- open [http://localhost:3002](http://localhost:3002) for the docs
[Tunnelmole](https://github.com/robbie-cahill/tunnelmole-client), 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](https://tunnelmole.com/downloads/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.
```
➜ ~ tmole 3000
http://bvdo5f-ip-49-183-170-144.tunnelmole.net is forwarding to localhost:3000
https://bvdo5f-ip-49-183-170-144.tunnelmole.net is forwarding to localhost:3000
```
### Videos
Videos to better understand the OpenStatus codebase:
- [The code behind OpenStatus and how it uses Turbopack](https://youtube.com/watch?v=PYfSJATE8v8).
- [Drop Betterstack and go open source](https://www.youtube.com/watch?v=PKag0USy3eQ)