Files
Checkmate/README.md
T

131 lines
7.9 KiB
Markdown
Raw Normal View History

2024-12-12 20:17:18 -05:00
2024-12-31 23:25:14 -05:00
2025-01-22 01:38:07 -05:00
<p align=center> <a href="https://trendshift.io/repositories/12443" target="_blank"><img src="https://trendshift.io/api/badge/repositories/12443" alt="bluewave-labs%2Fcheckmate | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a></p>
2024-12-20 19:58:44 -05:00
![](https://img.shields.io/github/license/bluewave-labs/checkmate)
![](https://img.shields.io/github/repo-size/bluewave-labs/checkmate)
![](https://img.shields.io/github/commit-activity/m/bluewave-labs/checkmate)
![](https://img.shields.io/github/last-commit/bluewave-labs/checkmate)
![](https://img.shields.io/github/languages/top/bluewave-labs/checkmate)
![](https://img.shields.io/github/issues/bluewave-labs/checkmate)
![](https://img.shields.io/github/issues-pr/bluewave-labs/checkmate)
2025-01-08 01:22:33 -05:00
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9901/badge)](https://www.bestpractices.dev/projects/9901)
2025-01-22 01:38:07 -05:00
<h1 align="center"><a href="https://bluewavelabs.ca" target="_blank">Checkmate</a></h1>
2025-01-06 04:42:56 -05:00
<p align="center"><strong>An open source uptime and infrastructure monitoring application</strong></p>
2024-07-25 14:54:50 -07:00
2025-01-06 04:42:56 -05:00
![dashboard](https://github.com/user-attachments/assets/252d6047-522b-4576-8f14-233510e464b8)
2024-08-23 22:15:19 -04:00
2024-12-21 13:41:35 -05:00
Checkmate is an open source monitoring tool used to track the operational status and performance of servers and websites. It regularly checks whether a server/website is accessible and performs optimally, providing real-time alerts and reports on the monitored services' availability, downtime, and response time.
2024-12-05 22:40:40 -05:00
Checkmate also has an agent, called [Capture](https://github.com/bluewave-labs/capture), to retrieve data from remote servers. While Capture is not required to run Checkmate, it provides additional insigths about your servers' CPU, RAM, disk and temperature status.
2024-12-21 13:41:35 -05:00
Checkmate has ben stress tested with 1000+ active monitors without any particular issues or performance bottlenecks.
2024-12-05 22:40:40 -05:00
2024-12-21 13:41:35 -05:00
We **love** what we are building here, and we contibuously learn a few things about Reactjs, Nodejs, MongoDB and Docker while building Checkmate.
2024-12-04 21:02:31 -05:00
## 📦 Demo
2024-09-19 07:41:42 -04:00
2024-12-21 13:41:35 -05:00
See [Checkmate](https://checkmate-demo.bluewavelabs.ca/) in action. The username is uptimedemo@demo.com and the password is Demouser1! (just a note that we update the demo server from time to time, so if it doesn't work for you, please ping us on Discussions channel).
2024-09-19 07:41:42 -04:00
2024-12-04 21:02:31 -05:00
## 🔗 User's guide
2024-10-04 00:56:37 -04:00
2024-12-21 13:41:35 -05:00
Usage instructions can be found [here](https://bluewavelabs.gitbook.io/checkmate). It's still WIP and some of the information there might be outdated. Rest assured, we are doing our best! :)
2024-10-04 01:24:17 -04:00
2024-12-04 21:02:31 -05:00
## 🛠️ Installation
2024-10-04 01:24:17 -04:00
2024-12-21 13:41:35 -05:00
See installation instructions in [Checkmate documentation portal](https://bluewavelabs.gitbook.io/checkmate/quickstart). Alternatively, you can also use [Coolify](https://coolify.io/) for a one click Docker deployment. If you would like to monitor your server infrastructure, you'll need [Capture agent](https://github.com/bluewave-labs/capture). Capture repository also contains the installation instructions.
2024-10-04 00:56:37 -04:00
2024-12-04 21:02:31 -05:00
## 💚 Questions & ideas
2024-09-30 20:00:51 -04:00
2024-12-12 20:23:21 -05:00
If you have any questions, suggestions or comments, please use our [Discord channel](https://discord.gg/NAb6H3UTjK). We've also launched our [Discussions](https://github.com/bluewave-labs/bluewave-uptime/discussions) page! Feel free to ask questions or share your ideas—we'd love to hear from you!
2024-09-30 20:00:51 -04:00
2024-12-04 21:02:31 -05:00
## 🧩 Features
2024-07-28 17:34:23 -04:00
2024-10-10 22:31:19 -04:00
- Completely open source, deployable on your servers
- Website monitoring
2024-12-04 20:37:26 -05:00
- Page speed monitoring
- Infrastructure monitoring (memory, disk usage, CPU performance etc) - requires [Capture](https://github.com/bluewave-labs/capture)
- Docker monitoring
2024-10-10 22:31:19 -04:00
- Ping monitoring
2025-01-01 08:55:47 -05:00
- SSL monitoring
2024-10-10 22:31:19 -04:00
- Incidents at a glance
- E-mail notifications
- Scheduled maintenance
2024-07-28 17:36:54 -04:00
2024-12-04 21:03:54 -05:00
**Short term roadmap:**
2024-08-13 13:29:12 -07:00
2025-01-18 21:53:53 -05:00
- Port monitoring (**complete**, waiting to be deployed to stable version) https://github.com/bluewave-labs/Checkmate/issues/1476
2025-01-22 00:02:17 -05:00
- Global (distributed) uptime checking on Solana network (**in progress**) https://github.com/bluewave-labs/Checkmate/issues/1593
2025-01-18 21:53:53 -05:00
- Status pages (**in progress**) https://github.com/bluewave-labs/Checkmate/issues/1131
2025-01-18 13:21:19 -05:00
- Translations (i18n) (**in progress**)
2025-01-22 00:02:17 -05:00
- Better notification options (Webhooks, Discord, Telegram, Slack) (**in progress**) https://github.com/bluewave-labs/Checkmate/issues/1545
- Command line interface (CLI) (**in progress**) https://github.com/bluewave-labs/Checkmate/issues/1558
2025-01-18 21:53:53 -05:00
- JSON query monitoring https://github.com/bluewave-labs/Checkmate/issues/1573
- Tagging/grouping monitors https://github.com/bluewave-labs/Checkmate/issues/1546
2025-01-22 00:02:17 -05:00
- More configuration options
2024-12-05 22:40:40 -05:00
- DNS monitoring
2024-08-09 15:48:10 -04:00
2024-12-10 01:31:40 -05:00
## 🏗️ Screenshots
2025-01-19 01:29:03 -05:00
<p>
2025-01-14 23:11:44 -05:00
<img width="2714" alt="server" src="https://github.com/user-attachments/assets/f7cb272a-69a6-48c5-93b0-249ecf20ecc6" />
2025-01-19 01:29:03 -05:00
</p>
2025-01-14 23:11:44 -05:00
<p>
<img width="2714" alt="uptime" src="https://github.com/user-attachments/assets/98ddc6c0-3384-47fd-96ce-7e53e6b688ac" />
2025-01-19 01:29:03 -05:00
</p>
2025-01-14 23:11:44 -05:00
<p>
<img width="2714" alt="page speed" src="https://github.com/user-attachments/assets/b5589f79-da30-4239-9846-1f8bb2637ff9" />
2025-01-19 01:29:03 -05:00
</p>
2024-12-10 01:31:40 -05:00
2024-12-04 21:02:31 -05:00
## 🏗️ Tech stack
2024-07-28 17:34:23 -04:00
2024-08-13 13:29:12 -07:00
- [ReactJs](https://react.dev/)
- [MUI (React framework)](https://mui.com/)
- [Node.js](https://nodejs.org/en)
- [MongoDB](https://mongodb.com)
2025-01-10 23:48:24 -05:00
- [Recharts](https://recharts.org)
2024-12-21 13:41:35 -05:00
- Lots of other open source components!
2024-07-28 17:34:23 -04:00
2025-01-18 14:07:35 -05:00
## A few links
- If you would like to support us, please consider giving it a ⭐ and click on "watch".
- Have a question or suggestion for the roadmap/featureset? Check our [Discord channel](https://discord.gg/NAb6H3UTjK) or [Discussions](https://github.com/bluewave-labs/checkmate/discussions) forum.
- Need a ping when there's a new release? Use [Newreleases](https://newreleases.io/), a free service to track releases.
- Watch a Checkmate [installation and usage video](https://www.youtube.com/watch?v=GfFOc0xHIwY)
2024-12-04 21:02:31 -05:00
## 🤝 Contributing
2025-01-10 23:48:24 -05:00
We pride ourselves on building strong connections with contributors at every level. Despite being a young project, Checkmate has already earned 3300 stars and attracted 40+ contributors from around the globe. So, don’t hold back — jump in, contribute and learn with us!
2024-12-04 20:37:26 -05:00
Here's how you can contribute:
2024-12-09 16:20:18 -05:00
0. Star this repo :)
2024-12-13 13:20:33 -05:00
1. Check [Contributor's guideline](https://github.com/bluewave-labs/bluewave-uptime/blob/master/CONTRIBUTING.md). First timers are encouraged to check `good-first-issue` tag.
2024-12-13 22:45:50 -05:00
2. Optionally, read [project structure](https://bluewavelabs.gitbook.io/checkmate/developers-guide/general-project-structure) and [high level overview](https://bluewavelabs.gitbook.io/checkmate/developers-guide/high-level-overview).
3. Have a look at our Figma designs [here](https://www.figma.com/design/RPSfaw66HjzSwzntKcgDUV/Uptime-Genie?node-id=0-1&t=WqOFv9jqNTFGItpL-1) if you are going to use one of our designs. We encourage you to copy to your own Figma page, then work on it as it is read-only.
4. Open an issue if you believe you've encountered a bug.
5. Check for good-first-issue's if you are a newcomer.
6. Make a pull request to add new features/make quality-of-life improvements/fix bugs.
2024-12-28 00:43:27 -05:00
<a href="https://github.com/bluewave-labs/checkmate/graphs/contributors">
2024-12-21 13:41:35 -05:00
<img src="https://contrib.rocks/image?repo=bluewave-labs/checkmate" />
</a>
2024-12-28 00:43:27 -05:00
<!--
2024-07-28 19:42:19 -04:00
![Alt](https://repobeats.axiom.co/api/embed/c35d999c82dbb31e967427ea4166c14da4172e73.svg "Repobeats analytics image")
2024-12-28 00:43:27 -05:00
-->
2024-12-21 13:41:35 -05:00
[![Star History Chart](https://api.star-history.com/svg?repos=bluewave-labs/checkmate&type=Date)](https://star-history.com/#bluewave-labs/bluewave-uptime&Date)
2024-08-18 01:57:16 -04:00
2024-08-19 14:28:18 -07:00
Also check other developer and contributor-friendly projects of BlueWave:
2024-08-17 19:14:22 -04:00
2025-01-05 20:49:23 -05:00
- [DataRoom](https://github.com/bluewave-labs/bluewave-dataroom), an secure file sharing application, aka dataroom.
2024-12-21 13:41:35 -05:00
- [BlueWave HRM](https://github.com/bluewave-labs/bluewave-hrm), a complete Human Resource Management platform.
2025-01-05 20:49:23 -05:00
- [Guidefox](https://github.com/bluewave-labs/guidefox), an application that helps new users learn how to use your product via hints, tours, popups and banners.
2024-12-21 13:41:35 -05:00
- [VerifyWise](https://github.com/bluewave-labs/verifywise), the first open source AI governance platform.
2024-08-17 19:14:22 -04:00
2025-01-14 18:57:15 -05:00
![image](https://badges.pufler.dev/visits/bluewave-labs/checkmate) since 14 Jan, 2025