Skip to content

openstatusHQ/openstatus

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

* add requirements

* add a general setup

* add a more ext-explanation about the .env

* add _meta index

* remove some lines
c4eb4c9

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
June 20, 2023 19:55
August 3, 2023 22:30
August 3, 2023 20:20
June 29, 2023 13:14
July 5, 2023 19:17
June 20, 2023 08:34
July 28, 2023 17:57

The Open-source Status Page and Alerting System

The Atlassian's Statuspage Open Source Alternative.
Learn more Β»

Discord Β· Website Β· Issues Β· Roadmap

About OpenStatus

OpenStatus is open-source status page and alerting system. 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 hello@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

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