Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 2.07 KB

README.md

File metadata and controls

65 lines (43 loc) · 2.07 KB

LiteStatus

About • Features • Quick Start & Information • Download

About

Built with Astro

LiteStatus is a lightweight site uptime monitoring solution that uses GitHub Actions to regularly check the availability of specified websites. Results are stored in a JSON file (pingResults.json) this file is accessed by the front end, built with Astro.js, to provide a dynamically updated status page hosted on GitHub Pages. This setup enables a fully automated, cost-free, and easily customizable status page deployment just using GitHub's free ecosystem.

Features

  • The GitHub Action pings each website hourly, ensuring your status page displays current availability.
  • pingResults.json provides a structured and easily parsable format, ideal for front-end integration.
  • Leverages Astro.js for a static site build, making it efficient and flexible for customization.
  • Host the entire solution on GitHub with GitHub Pages and GitHub Actions.

Quick Start & Information

To start the project, ensure Node.js is installed on your system and pnpm is set up as the package manager. Follow these steps:

Install pnpm globally:

npm install -g pnpm

Clone the repository:

git clone https://github.com/SegoCode/LiteStatus
cd code/front

Install dependencies and build the project:

pnpm install

Run the development environment:

pnpm dev

Note

Remember that deploy the project in local will still make the request to the json data hosted on github

Download

Download the latest version of pingResults.json here.