https://github.com/FuturePortal/CIMonitor

Displays CI statuses on a dashboard and triggers fun modules representing the status!
https://github.com/FuturePortal/CIMonitor

cd ci ci-status continuous-deployment continuous-integration dashboard github github-actions gitlab gpio hacktoberfest hacktoberfest2023 monitoring pipeline raspberry-pi webhooks

Last synced: 7 months ago
JSON representation

Displays CI statuses on a dashboard and triggers fun modules representing the status!

• Host: GitHub
• URL: https://github.com/FuturePortal/CIMonitor
• Owner: FuturePortal
• License: mit
• Created: 2016-04-15T07:57:09.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-07-12T09:35:26.000Z (over 1 year ago)
• Last Synced: 2024-08-04T09:04:18.816Z (over 1 year ago)
• Topics: cd, ci, ci-status, continuous-deployment, continuous-integration, dashboard, github, github-actions, gitlab, gpio, hacktoberfest, hacktoberfest2023, monitoring, pipeline, raspberry-pi, webhooks
• Language: TypeScript
• Homepage:
• Size: 51.3 MB
• Stars: 48
• Watchers: 5
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# [![image](https://avatars2.githubusercontent.com/u/18479455?s=60&v=4)](https://cimonitor.readthedocs.io) CIMonitor v4

[![release](https://img.shields.io/github/release/FuturePortal/CIMonitor.svg)](https://github.com/FuturePortal/CIMonitor/releases)

[![MIT](https://img.shields.io/github/license/FuturePortal/CIMonitor.svg)](https://github.com/FuturePortal/CIMonitor/)

[![docker pulls](https://img.shields.io/docker/pulls/cimonitor/server.svg)](https://hub.docker.com/u/cimonitor/)

[![stars](https://img.shields.io/github/stars/FuturePortal/CIMonitor.svg)](https://github.com/FuturePortal/CIMonitor/stargazers)

[![read-the-docs](https://readthedocs.org/projects/cimonitor/badge/?version=latest)](https://cimonitor.readthedocs.io)

CIMonitor is a place where all your CI statuses come together. Check if all tests have passed, and if

deployments are successful. All in one overview. This is all done via **webhooks**, so no complex configuration.

[Get started](https://cimonitor.readthedocs.io/en/latest/getting-started)!

## Supported webhooks

- [GitHub](https://cimonitor.readthedocs.io/en/latest/webhook/github/)

- [GitLab](https://cimonitor.readthedocs.io/en/latest/webhook/gitlab/)

- [Read the Docs](https://cimonitor.readthedocs.io/en/latest/webhook/readthedocs/)

- [BitBucket](https://cimonitor.readthedocs.io/en/latest/webhook/bitbucket/)

## Example

![Dashboard demonstration](docs/images/dashboard.gif)

# Getting started

The easiest and quickest way to run CIMonitor is via docker. But there are other options available for you. Check the

options below in the documentation:

- [docker](https://cimonitor.readthedocs.io/en/latest/run/docker/)

- [kubernetes](https://cimonitor.readthedocs.io/en/latest/run/kubernetes/)

- [locally with nodejs](https://cimonitor.readthedocs.io/en/latest/run/locally/)

# Development

To start development, run the following commands on your terminal:

- `./Taskfile`: See all available make commands.

- `./Taskfile init`: Set up the project for local development (required to run locally).

- `./Taskfile start`: Run the development server.

# Contributors

A big thanks to all the contributors who make CIMonitor what it is today!

![contirubtor avatars](https://contrib.rocks/image?repo=futureportal/cimonitor)