From 39a9b96f2b1da585a9841e727be713606a025c55 Mon Sep 17 00:00:00 2001
From: "Gorkem Cetin (BWL)" <167266851+gorkem-bwl@users.noreply.github.com>
Date: Tue, 22 Apr 2025 12:10:56 -0400
Subject: [PATCH] Update README.md
---
client/README.md | 144 +----------------------------------------------
1 file changed, 1 insertion(+), 143 deletions(-)
diff --git a/client/README.md b/client/README.md
index 1600c9815..ee3ed2de2 100644
--- a/client/README.md
+++ b/client/README.md
@@ -1,144 +1,2 @@
- 
-
-
-
-
-
-
-
-
-[](https://www.bestpractices.dev/projects/9901)
-
-
-An open source uptime and infrastructure monitoring application
-
-
-
-This repository contains the **frontend** of Checkmate, an open-source, self-hosted monitoring tool for tracking server hardware, uptime, response times, and incidents in real-time with beautiful visualizations. Checkmate 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 insights about your servers' CPU, RAM, disk, and temperature status.
-
-Checkmate has been stress-tested with 1000+ active monitors without any particular issues or performance bottlenecks.
-
-We **love** what we are building here, and we continuously learn a few things about Reactjs, Nodejs, MongoDB, and Docker while building Checkmate.
-
-For backend files, please check [Checkmate backend](https://github.com/bluewave-labs/checkmate-backend) repository.
-
-## 📦 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 the Discussions channel).
-
-## 🔗 User's guide
-
-Usage instructions can be found [here](https://docs.checkmate.so/). It's still WIP and some of the information there might be outdated as we continuously add features weekly. Rest assured, we are doing our best! :)
-
-## 🛠️ Installation
-
-See installation instructions in [Checkmate documentation portal](https://docs.checkmate.so/quickstart). Alternatively, you can also use [Coolify](https://coolify.io/) or [Elestio](https://elest.io/open-source/checkmate) 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.
-
-## 🏁 Translations
-
-If you would like to use Checkmate in your language, please [go to this page](https://poeditor.com/join/project/lRUoGZFCsJ) and register for the language you would like to translate Checkmate to.
-
-## 🚀 Performance
-
-Thanks to extensive optimizations, Checkmate operates with an exceptionally small memory footprint, requiring minimal memory and CPU resources. Here’s the memory usage of a Node.js instance running on a server that monitors 323 servers every minute:
-
-
-
-You can see the memory footprint of MongoDB and Redis on the same server (398Mb and 15Mb) for the same amount of servers:
-
-
-
-## 💚 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
-- SSL monitoring
-- Port monitoring
-- Incidents at a glance
-- E-mail notifications
-- Scheduled maintenance
-
-**Short term roadmap:**
-
-- Global (distributed) uptime checking on Solana network (**in progress**) https://github.com/bluewave-labs/Checkmate/issues/1593
-- Status pages (**in progress**) https://github.com/bluewave-labs/Checkmate/issues/1131
-- Translations (i18n) (**in progress**)
-- Better notification options (Webhooks, Discord, Telegram, Slack) (**in progress**) https://github.com/bluewave-labs/Checkmate/issues/1545
-- JSON query monitoring https://github.com/bluewave-labs/Checkmate/issues/1573
-- Tagging/grouping monitors https://github.com/bluewave-labs/Checkmate/issues/1546
-- More configuration options
-- DNS monitoring
-
-## 🏗️ Screenshots
-
-
-
-
-
-
-
-
-
-
-
-## 🏗️ Tech stack
-
-- [ReactJs](https://react.dev/)
-- [MUI (React framework)](https://mui.com/)
-- [Node.js](https://nodejs.org/en)
-- [MongoDB](https://mongodb.com)
-- [Recharts](https://recharts.org)
-- Lots of other open source components!
-
-## 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)
-
-## 🤝 Contributing
-
-We are [Alex](http://github.com/ajhollid) (team lead), [Vishnu](http://github.com/vishnusn77), [Mohadeseh](http://github.com/mohicody), [Gorkem](http://github.com/gorkem-bwl/), [Owaise](http://github.com/Owaiseimdad), and [Aryaman](https://github.com/Br0wnHammer) helping individuals and businesses monitor their infra and servers.
-
-We pride ourselves on building strong connections with contributors at every level. Despite being a young project, Checkmate has already earned 4.6K+ stars and attracted 60 contributors from around the globe.
-
-Our repo is starred by employees from **Google, Microsoft, Intel, Cisco, Tencent, Electronic Arts, ByteDance, JP Morgan Chase, Deloitte, Accenture, Foxconn, Broadcom, China Telecom, Barclays, Capgemini, Wipro, Cloudflare, Dassault Systèmes and NEC**, 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/Checkmate/blob/develop/CONTRIBUTING.md). First timers are encouraged to check `good-first-issue` tag.
-2. Optionally, read [project structure](https://docs.checkmate.so/developers-guide/general-project-structure) and [high level overview](https://bluewavelabs.gitbook.io/checkmate/developers-guide/high-level-overview).
-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.
-
-
- 
-
-
-## 💰 Our sponsors
-
-Thanks to [Gitbook](https://gitbook.io/) for giving us a free tier for their documentation platform, and [Poeditor](https://poeditor.com/) providing us a free account to use their i18n services. If you would like to sponsor Checkmate, please send an email to hello@bluewavelabs.ca
-
-[](https://star-history.com/#bluewave-labs/bluewave-uptime&Date)
-
-Also check other developer and contributor-friendly projects of BlueWave:
-
-- [LangRoute](https://github.com/bluewave-labs/langroute), an LLM proxy and gateway
-- [DataRoom](https://github.com/bluewave-labs/bluewave-dataroom), an secure file sharing application, aka dataroom.
-- [Headcount](https://github.com/bluewave-labs/bluewave-hrm), a complete Human Resource Management platform.
-- [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.
-- [VerifyWise](https://github.com/bluewave-labs/verifywise), the first open source AI governance platform.
+This directory contains the client side (frontend) of Checkmate.