Status Page

Open-source status page to keep track of your favorite url.

Screenshot

Tech Stack

• Framework: Nuxt
• UI Library: nuxt/ui
• Content: nuxt/content

Getting Started

Make sure to install the dependencies with pnpm

1. Clone the Repo

Start by cloning this repo to your local machine and navigating into the directory.

git clone https://github.com/roiLeo/open-status
cd open-status

2. Install Dependencies

Then, install the project dependencies:

pnpm install

3. Set Environment Variables

Copy the .env.example file to .env:

cp .env.example .env

4. Setup new endpoint

Create a new yaml file inside /content/urls (e.g. wikipedia.yaml)

url: "https://www.wikipedia.org/"
title: "Wikipedia"
description: "The Free Encyclopedia"

5. Run health-check

In order to scan endpoints, run the following commands:

sh .script/health-check.sh

Deployment

Checkout the deployment documentation for more information.