Skip to content

Latest commit

 

History

History
81 lines (51 loc) · 2.02 KB

README.md

File metadata and controls

81 lines (51 loc) · 2.02 KB

Webtop

A lightweight, Rust-powered web server for real-time system monitoring.

Preview

Features

  • Memory: Available, usage, and swap statistics.
  • CPU: Core count, usage percentage, load averages, and processor name.
  • GPU: Graphics card name, memory usage, and temperature.
  • System: Hostname, kernel version, operating system, and uptime.
  • Networks: Active interfaces with received and transmitted data stats.
  • Processes: Details like PID, name, CPU/RAM usage, virtual memory, status, and runtime.---

Development Checklist

  • RAM Information (DDR4...)
  • Process Sorting and Filters
  • Various colorschemes
  • Make the sorting fast
  • Configurable server
  • Only refresh data that may change

Setup

Make sure Rust is installed. A Linux OS is preffered.

Usage

After you clone this repo to your desktop, go to its root directory and run cargo run to run the server. The default port is 3000

Contributing

We welcome contributions of all kinds, from bug fixes to new features!

Steps to Contribute

  1. Fork the Repository

    git clone https://github.com/Muxutruk2/webtop.git
cd webtop

  2. Create a Branch

Use a descriptive name for your branch:

git checkout -b feature/your-feature-name

  1. Make Changes
    Implement your changes and ensure they align with Rust best practices.

  2. Test Your Changes

Ensure all functionality is working and the code is ready to merge by using cargo clippy

  1. Submit a Pull Request (PR)
    Push your branch and open a PR to the main repository. Clearly describe your changes and link any related issues.

Contribution Guidelines

  • Write clear, concise commit messages.
  • Update documentation if your changes affect usage.
  • Be respectful and constructive in discussions.

License

This project is licensed under the terms of the MIT License.
See the full license here.