Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Pranjal Rana <[email protected]>
  • Loading branch information
PRANJALRANA11 authored Nov 7, 2023
1 parent 41049b8 commit 27ae365
Showing 1 changed file with 81 additions and 2 deletions.
83 changes: 81 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,81 @@
# Docker-Container-Optimization-ml-project
Container optimization project
<h1 align="center" id="title">Docker Image Optimizer Plane</h1>

<p align="center"><img src="https://socialify.git.ci/PRANJALRANA11/Docker-Container-Optimization-ml-project/image?description=1&amp;descriptionEditable=Welcome%20to%20Docker%20Image%20Analyzer%20%26%20Optimizer%20-%20the%20comprehensive%20tool%20designed%20to%20help%20developers%20streamline%20their%20Docker%20images.%20Our%20project%20provides%20an%20intuitive%20suite%20of%20tools%20that%20assist%20in%20scrutinizing%20Docker%20images%20for%20inefficiencies%20and%20potential%20improvements%2C%20offering%20actionable%20insights%20to%20enhance%20image%20performance%20and%20reduce%20size.&amp;font=Bitter&amp;forks=1&amp;issues=1&amp;language=1&amp;name=1&amp;owner=1&amp;pattern=Circuit%20Board&amp;pulls=1&amp;stargazers=1&amp;theme=Dark" alt="project-image"></p>

<p id="description">Welcome to Docker Image Analyzer &amp; Optimizer - the comprehensive tool designed to help developers streamline their Docker images. Our project provides an intuitive suite of tools that assist in scrutinizing Docker images for inefficiencies and potential improvements offering actionable insights to enhance image performance and reduce size.</p>

<p align="center"><img src="https://img.shields.io/badge/docker%20-%20green" alt="shields"><img src="https://img.shields.io/badge/dive%20-%20yellow" alt="shields"><img src="https://img.shields.io/badge/slim%20-%20red" alt="shields"></p>

<h2>🚀 Demo</h2>

[https://youtu.be/5V1Viktgpbw?si=uYCeInPv\_hlDyIV\_](https://youtu.be/5V1Viktgpbw?si=uYCeInPv_hlDyIV_)

<h2>Project Screenshots:</h2>

<img src="https://github.com/PRANJALRANA11/Docker-Container-Optimization-ml-project/assets/129268721/87d0df5c-201a-4898-896b-c57ab062ed0f" alt="project-screenshot" width="400" height="400/">

<img src="https://github.com/PRANJALRANA11/Docker-Container-Optimization-ml-project/assets/129268721/3863c6e1-709a-43b2-ba0b-600d03c78371" alt="project-screenshot" width="400" height="400/">

<img src="https://github.com/PRANJALRANA11/Docker-Container-Optimization-ml-project/assets/129268721/7274a918-859d-43e0-8a0a-92edb47b649a" alt="project-screenshot" width="400" height="400/">



<h2>🧐 Features</h2>

Here're some of the project's best features:

* Image Analysis: Deeply inspect your Docker images to identify what's inside. Get detailed breakdowns of image layers file contents and metadata.
* Size Optimization: Receive recommendations for reducing image size without compromising functionality. Detect unnecessary files suggest alpine or slim variants of base images and more
* Security Scanning: Scan your images for known vulnerabilities and get advice on how to address them.
* Visualization: Interactive visualizations to help you better understand the structure and composition of your Docker images.

<h2>🛠️ Installation Steps:</h2>

<p>1. Install Docker desktop</p>

<p>2. Pull the server image from docker hub</p>

```
docker pull deepeshkalura/docker_image_server_for_optimization
```

<p>3. Pull the client image from docker hub</p>

```
docker pull deepeshkalura/docker_image_client_for_optimization
```

<p>4. Run both images</p>

```
docker run
```

<p>5. That's it</p>

<h2>🍰 Contribution Guidelines:</h2>

We welcome contributions from the community! Please read our Contributing Guide for details on our code of conduct and the process for submitting pull requests to us.



<h2>💻 Built with</h2>

Technologies used in the project:

* Typescript
* React js
* Tailwind css
* Fast api
* python
* docker
* slim
* dive

<h2>🛡️ License:</h2>

This project is licensed under the MIT

<h2>💖Like my work?</h2>

Need help? Open an issue in our Issues Tracker or join our community chat on Discord. Join us in making Docker usage more efficient and secure for everyone!

0 comments on commit 27ae365

Please sign in to comment.