An open API service indexing awesome lists of open source software.

https://github.com/aneeshshukla/checkmate

Track, Optimize, Monitor devices, manage files, execute tasks, adjust settings, and stay connected securely—all in one platform.
https://github.com/aneeshshukla/checkmate

cross-platform flask lightweight monitoring open-source python python3 real-time server system-administration tracker usage

Last synced: 10 months ago
JSON representation

Track, Optimize, Monitor devices, manage files, execute tasks, adjust settings, and stay connected securely—all in one platform.

Awesome Lists containing this project

README

          

# Checkmate



Status
PRs Welcome



## 🚀 About Checkmate

**Checkmate** is a Python-based Flask application currently in beta. It provides a real-time dashboard to monitor your PC's usage statistics, including CPU, memory, disk, and network usage. Designed for developers and system administrators, Checkmate helps you stay informed about your system's performance at a glance.

---

## 🛠️ Features

- **Real-Time Monitoring**: Get instant updates on CPU, RAM, disk, and network usage.
- **User-Friendly Dashboard**: A clean and responsive web interface built with Flask.
- **Customizable Settings**: Tailor the data display to your preferences.
- **Cross-Platform**: Runs on Windows, macOS, and Linux.
- **Lightweight and Fast**: Minimal resource usage.

---

## 🏗️ Installation

Follow these steps to set up Checkmate on your system:

1. **Clone the Repository**:

```bash
git clone https://github.com/aneeshshukla/checkmate.git
cd checkmate
```

2. **Install Dependencies**:

```bash
pip install -r requirements.txt
```

3. **Run the Application**:

```bash
python app.py
```

4. **Open in Browser**:
Visit `http://127.0.0.1:51234` or `https://:51234` to access the dashboard.

---

## 🛑 Requirements

Before running Checkmate, ensure you have the following:

- Python 3.8 or later
- Flask (install via `pip install flask`)
- psutil (install via `pip install psutil`)
- pygetwindow (install via `pip install pygetwindow`)
- GPUtil (install via `pip install GPUtil`)
- pywin32 (install via `pip install pywin32`)

---

## 🌟 Contribution Guidelines

We welcome contributions to make Checkmate even better! Here’s how you can contribute:

- Fork the repository.
- Create a new branch for your feature/fix.
- Commit your changes and submit a pull request.
- Ensure all changes are tested thoroughly.

---

## 📜 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

| Permissions | Conditions | Limitations |
| ----------------- | ------------------------------- | ------------ |
| 🟢 Commercial use | 🔵 License and copyright notice | 🔴 Liability |
| 🟢 Distribution | | 🔴 Warranty |

🟢 Modification
🟢 Private use

---

## 💬 Feedback and Support

If you have any feedback, suggestions, or issues, feel free to:

- Open an issue [here](https://github.com/aneeshshukla/checkmate/issues)
- Join our discussions [here](https://github.com/aneeshshukla/checkmate/discussions)

---

## 🛠️ Future Plans

- Add support for more detailed hardware monitoring.
- Integrate alerts for critical system usage.
- Create a plugin system for additional functionality.

---


Made with ❤️ by aneeshshukla