https://github.com/checkly/statuspage-aggregator
statuspage-aggregator
https://github.com/checkly/statuspage-aggregator
Last synced: 15 days ago
JSON representation
statuspage-aggregator
- Host: GitHub
- URL: https://github.com/checkly/statuspage-aggregator
- Owner: checkly
- License: mit
- Created: 2023-12-19T11:43:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-19T15:05:39.000Z (over 2 years ago)
- Last Synced: 2026-04-01T08:44:03.167Z (3 months ago)
- Language: TypeScript
- Size: 41 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Checkly MaC Status Page Aggregator
This project is designed to aggregate status pages into a single Checkly public dashboard. It leverages the concept of Monitoring as Code (MaC) to deploy the created checks with a 'statuspage' tag, ensuring they appear on the automatically created dashboard.
## Features
- Aggregates multiple status pages into one Checkly public dashboard.
- Uses Monitoring as Code (MaC) for deploying checks.
- Automatically tags checks with 'statuspage' for easy identification and organization.
- Includes convenient npm run commands for deployment and testing.
## Configuration
A notable feature of this project is the "only" tweak in `checky.config.ts`. This allows you to run a single test when you execute `npm test`, which can be particularly useful during development or debugging.
## Available Scripts
In the project directory, you can run:
### `npm run deploy`
Deploys the checks to the Checkly dashboard.
### `npm test`
Launches the test runner. If the "only" tweak in `checky.config.ts` is used, only one test will be executed.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)