Files
Checkmate/README.md
T

104 lines
5.2 KiB
Markdown
Raw Normal View History

2024-12-12 20:17:18 -05:00
**Need support or have a suggestion? Check our [Discord channel](https://discord.gg/NAb6H3UTjK)**
2024-06-07 13:38:32 -07:00
![](https://img.shields.io/github/license/bluewave-labs/bluewave-uptime)
![](https://img.shields.io/github/repo-size/bluewave-labs/bluewave-uptime)
![](https://img.shields.io/github/commit-activity/w/bluewave-labs/bluewave-uptime)
![](https://img.shields.io/github/last-commit/bluewave-labs/bluewave-uptime)
![](https://img.shields.io/github/languages/top/bluewave-labs/bluewave-uptime)
![](https://img.shields.io/github/issues-pr/bluewave-labs/bluewave-uptime)
![](https://img.shields.io/github/issues/bluewave-labs/bluewave-uptime)
<h1 align="center"><a href="https://bluewavelabs.ca" target="_blank">Checkmate</a></h1>
2024-07-25 14:54:50 -07:00
<p align="center"><strong>An open source server monitoring application</strong></p>
2024-09-04 21:50:26 -04:00
![Dashboard-dark](https://github.com/user-attachments/assets/db875138-164f-453c-a75e-889f88747578)
2024-08-23 22:15:19 -04:00
2024-12-05 22:40:40 -05:00
Checkmate is an open source uptime manager, server & Docker 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.
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.
We **love** what we are building here, and learn a few things about Reactjs, Nodejs, MongoDB and Docker while building Checkmate. **If you would like to support us, please consider giving it a ⭐, think about contributing or providing feedback.** Please note that we do not operate a monetary donation program, make money by deploying servers, or run a SaaS business.
2024-12-04 21:02:31 -05:00
## 📦 Demo
2024-09-19 07:41:42 -04:00
See [Checkmate](https://checkmate-demo.bluewavelabs.ca/) in action. The username is uptimedemo@demo.com and the password is Demouser1!
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-11-25 22:56:51 -05:00
Usage instructions can be found [here](https://bluewavelabs.gitbook.io/checkmate).
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-11-25 22:56:51 -05:00
See installation instructions in [Checkmate documentation portal](https://bluewavelabs.gitbook.io/checkmate/quickstart).
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
- Port monitoring
- Ping monitoring
- 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
2024-10-18 20:39:22 -04:00
- Status pages
2024-12-04 21:03:54 -05:00
- Better notification options
- More configuration options
2024-12-05 22:40:40 -05:00
- DNS monitoring
- SSL monitoring
2024-08-09 15:48:10 -04:00
2024-12-10 01:31:40 -05:00
## 🏗️ Screenshots
![Group 3765](https://github.com/user-attachments/assets/8e8144f2-a769-4707-8ea1-99cf758284a8)
![Group 3768](https://github.com/user-attachments/assets/05aed2f2-2cf7-487f-879b-cf8bfb0e9241)
![Group 3768-1](https://github.com/user-attachments/assets/d4ee4bcf-4d69-4e4a-9bce-fd3541129c24)
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)
2024-07-28 17:34:23 -04:00
2024-12-04 21:02:31 -05:00
## 🤝 Contributing
2024-12-12 14:03:26 -05:00
We pride ourselves on building strong connections with contributors at every level. Despite being a young project, Checkmate has already earned 1500 stars and attracted 35+ 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 :)
1. Check [Contributor's guideline](https://github.com/bluewave-labs/bluewave-uptime/blob/master/CONTRIBUTING.md).
2. Have a look at our Figma designs [here](https://www.figma.com/design/RPSfaw66HjzSwzntKcgDUV/Uptime-Genie?node-id=0-1&t=WqOFv9jqNTFGItpL-1). We encourage you to copy to your own Figma page, then work on it as it is read-only.
3. Open an issue if you believe you've encountered a bug
4. Check for good-first-issue's if you are a newcomer
5. Make a pull request to add new features/make quality-of-life improvements/fix bugs.
<a href="https://github.com/bluewave-labs/bluewave-uptime/graphs/contributors">
<img src="https://contrib.rocks/image?repo=bluewave-labs/bluewave-uptime" />
</a>
Made with [contrib.rocks](https://contrib.rocks).
2024-07-28 19:42:19 -04:00
![Alt](https://repobeats.axiom.co/api/embed/c35d999c82dbb31e967427ea4166c14da4172e73.svg "Repobeats analytics image")
2024-08-18 01:57:16 -04:00
[![Star History Chart](https://api.star-history.com/svg?repos=bluewave-labs/bluewave-uptime&type=Date)](https://star-history.com/#bluewave-labs/bluewave-uptime&Date)
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
- [BlueWave HRM](https://github.com/bluewave-labs/bluewave-hrm)
- [BlueWave Onboarding](https://github.com/bluewave-labs/bluewave-onboarding)
- [BlueWave DataRoom](https://github.com/bluewave-labs/bluewave-dataroom)
2024-09-25 23:39:56 -04:00
- [VerifyWise](https://github.com/bluewave-labs/verifywise)
2024-08-17 19:14:22 -04:00