Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
🚀 README
Thibault Le Ouaya8a199244030
diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MDnew file mode 100644index 000000000..8b53ad6d0--- /dev/null+++ b/CONTRIBUTING.MD@@ -0,0 +1,4 @@+# Contributing to OpenStatus++We love contributions! It's the way we can make OpenStatus better for everyone.+🚀diff --git a/README.md b/README.mdindex e7e9ede04..c132807ba 100644--- a/README.md+++ b/README.md@@ -1,6 +1,39 @@+<p align="center" style="margin-top: 120px">++ <h3 align="center">The Open-source Status Page and Alerting System+ </h3>++ <p align="center">+ The Statuspage Open Source Alternative.+ <br />+ <a href="https://www.openstatus.dev"><strong>Learn more »</strong></a>+ <br />+ <br />+ <a href="">Discord</a>+ ·+ <a href="https://www.openstatus.dev">Website</a>+ ·+ <a href="https://github.com/mxkaske/openstatus/issues">Issues</a>+ ·+ <a href="https://github.com/mxkaske/openstatus/milestones">Roadmap</a>+ </p>+</p>+# OpenStatus-The Open-source monitoring platform+## About this project++OpenStatus is a free and open-source status page and alerting system.++## Contributing++Coming soon++## Contact us++If you want to lean more about this project or have any questions, send us an+email at [[email protected]](mailto:[email protected]) <br/> or <br/>+<a href="https://cal.com/thibault-openstatus/30min"><img alt="Book us with Cal.com" src="https://cal.com/book-with-cal-dark.svg" /></a>## Built with@@ -8,8 +41,6 @@ The Open-source monitoring platform- [Tailwind CSS](https://tailwindcss.com/)- [shadcn/ui](https://ui.shadcn.com/)--## Getting Started### Requirements@@ -22,7 +53,7 @@ The Open-source monitoring platform1. Clone the repository```sh- git clone https://github.com/openstatusHQ/openstatus.git+ git clone https://github.com/mxkaske/openstatus.git```2. Install dependencies@@ -31,43 +62,25 @@ The Open-source monitoring platformpnpm install```-3- from apps/web you will find .env.example create your own--NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=-CLERK_SECRET_KEY=-CLERK_WEBHOOK_SECRET=--NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in-NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up-NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/-NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/--# TinyBird-TINY_BIRD_API_KEY=--# Resend-RESEND_API_KEY=--# Upstash-UPSTASH_REDIS_REST_URL=-UPSTASH_REDIS_REST_TOKEN=--RESEND_API_KEY='api-key'-+3. Set up your .env file+ from `apps/web` and `packages/db` you will find .env.example create your own4. Start the development server```shpnpm dev+ ```+5. Open [http://localhost:3000](http://localhost:3000) with your browser to see+ the result.- ```--4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.+## Roadmap+Coming soon-## Authors+## Contributors-- [Maximilian Kaske](https://twitter.com/mxkaske)-- [Thibault Le Ouay Ducasse](https://twitter.com/thibaultleouay)+<a href="https://github.com/mxkaske/openstatus/graphs/contributors">+ <img src="https://contrib.rocks/image?repo=mxkaske/openstatus" />+</a>diff --git a/packages/db/.env.example b/packages/db/.env.examplenew file mode 100644index 000000000..0b4ea3edb--- /dev/null+++ b/packages/db/.env.example@@ -0,0 +1 @@+DATABASE_URL="planetscale-url"diff --git a/packages/db/README.md b/packages/db/README.mdnew file mode 100644index 000000000..bfcfe1934--- /dev/null+++ b/packages/db/README.md@@ -0,0 +1,9 @@+# DB++Our database package++## Getting started++1. Create you mysql database or use planetscale+2. Update your .env file with DATABASE_URL=""+3. Run `pnpm push` to push the tables