Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 1.72 KB

README.md

File metadata and controls

40 lines (24 loc) · 1.72 KB
Raw

DockerX: A Docker Management Dashboard

DockerX is a web application built with the Express, React, Node.js to manage and monitor Docker containers running on Linux systems. It provides a user-friendly interface for:

  • Listing Containers: View a list of all running containers with details like ID, image name, status (running, stopped, etc.).
  • Resource Monitoring: Visualize CPU and memory usage for each container graphically.
  • Container Control: Start, stop, or restart containers with a single click.

Getting Started

This project requires Node.js and npm (or yarn) to be installed on your system. Here's how to set up the development environment:

  1. Clone the repository:

    git clone https://github.com/Dwij13/DockerX.git
cd DockerX

Features

  • List running Docker containers with details (ID, Image, Status).
  • Visualize CPU and memory usage for each container.
  • Start, stop, and restart containers directly from the dashboard.

Tech Stack

  • Backend: Node.js, Express.js, (dockerode or Node.js Docker SDK)
  • Frontend: React.js
  • Charting Library (Optional): Chart.js, D3.js (for resource usage visualization)

Contributing

We welcome contributions to this project! Feel free to fork the repository, make changes, and submit pull requests. Please ensure your code adheres to the existing code style and functionality.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Note: This is a basic README template. You might need to modify it based on your specific implementation choices (dockerode vs. Node.js Docker SDK, including a database or not). Make sure to update the documentation and instructions to reflect the final setup.