mirror of
https://github.com/bluewave-labs/Checkmate.git
synced 2026-01-23 10:10:20 -06:00
119 lines
6.8 KiB
Markdown
119 lines
6.8 KiB
Markdown
**Need support or have a suggestion? Check our [Discord channel](https://discord.gg/NAb6H3UTjK) or [Discussions](https://github.com/bluewave-labs/checkmate/discussions) forum.**
|
||
|
||
**Checkmate is on [GitHub trending](https://github.com/trending) and #1 trending for JavaScript apps on Fri Dec 13th & 15th**
|
||
|
||
**If you would like to support us, please consider giving it a ⭐, and think about contributing or providing feedback.**
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h1 align="center"><a href="https://bluewavelabs.ca" target="_blank">Checkmate</a></h1>
|
||
|
||
<p align="center"><strong>An open source server and infrastructure monitoring application</strong></p>
|
||
|
||
|
||
|
||
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.
|
||
|
||
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.
|
||
|
||
Checkmate has ben stress tested with 1000+ active monitors without any particular issues or performance bottlenecks.
|
||
|
||
We **love** what we are building here, and we contibuously learn a few things about Reactjs, Nodejs, MongoDB and Docker while building Checkmate.
|
||
|
||
## 📦 Demo
|
||
|
||
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).
|
||
|
||
## 🔗 User's guide
|
||
|
||
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! :)
|
||
|
||
## 🛠️ Installation
|
||
|
||
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.
|
||
|
||
## 💚 Questions & ideas
|
||
|
||
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!
|
||
|
||
## 🧩 Features
|
||
|
||
- Completely open source, deployable on your servers
|
||
- Website monitoring
|
||
- Page speed monitoring
|
||
- Infrastructure monitoring (memory, disk usage, CPU performance etc) - requires [Capture](https://github.com/bluewave-labs/capture)
|
||
- Docker monitoring
|
||
- Ping monitoring
|
||
- Incidents at a glance
|
||
- E-mail notifications
|
||
- Scheduled maintenance
|
||
- Can monitor 1000+ servers at the same time on a moderate server
|
||
|
||
**Short term roadmap:**
|
||
|
||
- Global (distributed) uptime checking on Solana network
|
||
- Status pages
|
||
- Better notification options (think Discord, Telegram, Slack)
|
||
- More configuration options
|
||
- DNS monitoring
|
||
- SSL monitoring
|
||
- Port monitoring
|
||
|
||
## 🏗️ Screenshots
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
## 🏗️ Tech stack
|
||
|
||
- [ReactJs](https://react.dev/)
|
||
- [MUI (React framework)](https://mui.com/)
|
||
- [Node.js](https://nodejs.org/en)
|
||
- [MongoDB](https://mongodb.com)
|
||
- Lots of other open source components!
|
||
|
||
## 🤝 Contributing
|
||
|
||
We pride ourselves on building strong connections with contributors at every level. Despite being a young project, Checkmate has already earned 2700 stars and attracted almost 40 contributors from around the globe. So, don’t hold back — jump in, contribute and learn with us!
|
||
|
||
Here's how you can contribute:
|
||
|
||
0. Star this repo :)
|
||
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.
|
||
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.
|
||
|
||
<!-- <a href="https://github.com/bluewave-labs/checkmate/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=bluewave-labs/checkmate" />
|
||
</a>
|
||
|
||
Made with [contrib.rocks](https://contrib.rocks).
|
||
-->
|
||
|
||
|
||
|
||
[](https://star-history.com/#bluewave-labs/bluewave-uptime&Date)
|
||
|
||
Also check other developer and contributor-friendly projects of BlueWave:
|
||
|
||
- [BlueWave DataRoom](https://github.com/bluewave-labs/bluewave-dataroom), an secure file sharing application, aka dataroom.
|
||
- [BlueWave HRM](https://github.com/bluewave-labs/bluewave-hrm), a complete Human Resource Management platform.
|
||
- [BlueWave Onboarding](https://github.com/bluewave-labs/bluewave-onboarding), an application that helps new users learn how to use your product via hints, tours, popups and banners.
|
||
- [VerifyWise](https://github.com/bluewave-labs/verifywise), the first open source AI governance platform.
|
||
|