https://github.com/luludotdev/statty

A no-nonsense status page / statistics server.
https://github.com/luludotdev/statty

Last synced: 10 months ago
JSON representation

A no-nonsense status page / statistics server.

• Host: GitHub
• URL: https://github.com/luludotdev/statty
• Owner: luludotdev
• License: mit
• Created: 2020-07-16T12:14:41.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-08T15:03:59.000Z (over 3 years ago)
• Last Synced: 2025-05-07T03:11:30.346Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 1.68 MB
• Stars: 10
• Watchers: 1
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# 📈 Statty ![Docker Build](https://github.com/lolPants/statty/workflows/Docker%20Build/badge.svg)

> A no-nonsense status page / statistics server.

## ❔ What is Statty?

Statty is an application server that powers a status page. It monitors your services and keeps track of response times and average uptime. It is designed to be lightweight and minimal, you only need to configure it once and it does the rest.

Statty can also be configured to send notifications if services are reported to be unreachable, and send all clear notifications when they come back online. Alerts are sent via Slack-compatible webhooks, and can be enabled or disabled for each service.

Statty is built with [Next.js](https://github.com/vercel/next.js), which allows the dashboard to load fast and stay responsive.

![Statty Dashboard](https://raw.githubusercontent.com/lolPants/statty/master/assets/demo.png)

## 🚀 Running in Production

This project uses GitHub Actions to run automated docker builds, you can find them in this repo's [Package Registry](https://github.com/lolPants/statty/packages). A sample Docker Compose file has been provided for you to use as a reference.

### 📝 Configuration

Statty services are configured using YAML or JSON. A [JSON schema](https://raw.githubusercontent.com/lolPants/statty/master/assets/config.schema.json) has been provided for use in IDEs. By default, Statty looks for `config.yaml`, `config.yml`, or `config.json` in the application's root directory. You can override this behaviour using environment variables. Refer to `.env.example` for documentation.

Statty also requires a Redis database for persistence between restarts. This is configured using environment variables. Refer to `.env.example` for documentation.

## 💖 Special Thanks

* **[Vercel](https://github.com/vercel)** - Creating the Next.js Framework and SWR, as well as many other libraries used in this project.

* **[Elstat](https://gitdab.com/ashie/elstat)** - Being the inspiration for this project, and proving a solid base for the Statty dashboard.

* **[Font Awesome](https://fontawesome.com/)** - Awesome icons library that is used on the dashboard.

* **[Recharts](https://recharts.org/en-US/)** - Elegant React charts library that powers the dashboard's graphs.