nydragon / otop

OTOP

A new vision of monitoring and managing processes

Report Bug . Request Feature

Table Of Contents

• Table Of Contents
• About The Project
• Built With
• Getting Started
  • Prerequisites
    • Frontend
    • Backend
    • Frontend
• Usage
  • Permament Installation
• Roadmap
• Contributing
  • Creating A Pull Request
• License
• Authors
• Acknowledgements

About The Project

In the realm of system administration, htop has long been a staple for monitoring and managing processes. Its interactive interface and comprehensive information have made it an indispensable tool for system administrators and users alike. However, as technology evolves and user expectations shift, it is time to reimagine htop for the modern era.

We propose a reinvention of htop, embracing a modern design and leveraging the power of Rust, a programming language renowned for its performance, safety, and concurrency features. Our goal is to create a process viewer that not only retains the core functionality of htop but also enhances it with a user-friendly interface, improved performance, and cross-platform compatibility.

Built With

The best tools was used for this project

• React
• Typescript
• Sass
• Rust
• Axum

Getting Started

Prerequisites

As dependencies you will have to install the following software:

Frontend

• npm
• NodeJS

To easily manage your Node version it is recommended to use nvm or any other kind of Node version manager. Please refer to the .nvmrc file to know which Node version to download.

Backend

• Rust toolchain

You may find it on their website.

Frontend

1. Clone the repo

git clone https://github.com/Nydragon/otop.git

2. Install NPM packages

npm install --prefix packages/frontend;

Usage

To start the program on your local machine, you will need to start the backend, using the following command:

cargo run --manifest-path packages/backend;

And the frontend with the following:

npm run dev --prefix packages/frontend;

Permament Installation

If you wish to install the program permanently, you can follow these steps:

cargo build --manifest-path packages/backend/Cargo.toml --release;
chmod +x packages/backend/target/release/otop;
cp packages/backend/target/release/otop /bin; # Or any other directory in $PATH

npm run build --prefix packages/frontend;
cp packages/frontend/dist -r /www; # Or any other directory

Then to launch the software execute the following commands:

otop 2> /dev/null &;
miniserve /www --index index.html; # replace `www` by the path in which reside your build frontend files.

Feel free to substitue miniserve by any other http server. And then finally connect to the public address of the hosting device at the port :8080;

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

• Limeal (Paul G) - Comp Sci Student - Limeal (Paul G) - Frontend + Backend + ProcessLib
• Nydragon (Nicolas L) - Comp Sci Student - Nydragon (Nicolas L) - Backend + ProcessLib

Acknowledgements

• Limeal
• Nydragon