Skip to content

apantle/openstatus

 
 

Repository files navigation

The Open-source Status Page and Alerting System

The Statuspage Open Source Alternative.
Learn more »

Discord · Website · Issues · Roadmap

OpenStatus

About this project

OpenStatus is a free and open-source status page and alerting system.

Contributing

Coming soon

Contact us

If you want to learn more about this project or have any questions, send us an email at hello@openstatus.dev
or
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

Roadmap

Here's our roadmap feel free to contribute to it.

Contributors

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 95.7%
  • JavaScript 1.7%
  • MDX 1.3%
  • CSS 1.2%
  • Handlebars 0.1%