From 1b8d632c1ef3c03d75c6347be4f9091fc2ecd218 Mon Sep 17 00:00:00 2001 From: Alex Holliday Date: Mon, 17 Feb 2025 19:15:39 -0800 Subject: [PATCH] remove npmrc, copy readme --- .npmrc | 1 - README.md | 140 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 135 insertions(+), 6 deletions(-) delete mode 100644 .npmrc diff --git a/.npmrc b/.npmrc deleted file mode 100644 index 43c97e719..000000000 --- a/.npmrc +++ /dev/null @@ -1 +0,0 @@ -package-lock=false diff --git a/README.md b/README.md index f768e33fc..35f6676da 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,138 @@ -# React + Vite +

bluewave-labs%2Fcheckmate | Trendshift

+ +![](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) +[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9901/badge)](https://www.bestpractices.dev/projects/9901) -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +

Checkmate

-Currently, two official plugins are available: +

An open source uptime and infrastructure monitoring application

-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh +![dashboard](https://github.com/user-attachments/assets/252d6047-522b-4576-8f14-233510e464b8) + +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://docs.checkmate.so/). 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://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. + +## ๐Ÿš€ 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: + +![image](https://github.com/user-attachments/assets/37e04a75-d83a-488f-b25c-025511b492c9) + +You can see the memory footprint of MongoDB and Redis on the same server (398Mb and 15Mb) for the same amount of servers: + +![image](https://github.com/user-attachments/assets/3b469e85-e675-4040-a162-3f24c1afc751) + +## ๐Ÿ’š 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 +- Command line interface (CLI) (**in progress**) https://github.com/bluewave-labs/Checkmate/issues/1558 +- 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 + +

+server +

+

+uptime +

+

+page speed +

+ +## ๐Ÿ—๏ธ 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 pride ourselves on building strong connections with contributors at every level. Despite being a young project, Checkmate has already earned 3700+ stars and attracted 45+ 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://docs.checkmate.so/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. + + + + + +## ๐Ÿ’ฐ 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 + +[![Star History Chart](https://api.star-history.com/svg?repos=bluewave-labs/checkmate&type=Date)](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. + +![image](https://badges.pufler.dev/visits/bluewave-labs/checkmate) since 14 Jan, 2025