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