Dock-X

A kiosk application for monitoring Docker containers, built on Python 🐍 and Docker SDK 📦.

DOCK-X

A kiosk application for monitoring Docker containers, built on Python 🐍 and Docker SDK 📦.

📖 Table of Contents

📖 Table of Contents
📍 Overview
📦 Features
📂 repository Structure
⚙️ Modules
🚀 Getting Started
🛣 Roadmap
🤝 Contributing
📄 License
👏 Acknowledgments

📍 Overview

A kiosk application for monitoring Docker containers, built on Python 🐍 and Docker SDK 📦.

📦 Features

A kiosk application for monitoring Docker containers, built on Python 🐍 and Docker SDK 📦.

📂 Repository Structure

└── Dock-X/
    ├── .github/
    │   └── ISSUE_TEMPLATE/
    ├── dockx/
    │   ├── backend/
    │   │   └── gen.py
    |   |   └── network.py
    │   ├── cont.py
    │   ├── imagetk_linux_sol.txt
    │   ├── launcher.py
    │   ├── main.py
    │   └── stats_gen.py
    ├── poetry.lock
    ├── pyproject.toml

⚙️ Modules

Root

File	Summary
poetry.lock	HTTPStatus Exception: 404
pyproject.toml	HTTPStatus Exception: 404

Dockx

File	Summary
launcher.py	HTTPStatus Exception: 404
imagetk_linux_sol.txt	HTTPStatus Exception: 404
cont.py	HTTPStatus Exception: 404
stats_gen.py	HTTPStatus Exception: 404
main.py	HTTPStatus Exception: 404

Backend

File	Summary
gen.py	HTTPStatus Exception: 404

🚀 Getting Started

Dependencies

Please ensure you have the following dependencies installed on your system:

- ℹ️ Python 3.11

🔧 Installation

Clone the Dock-X repository:

git clone https://github.com/047pegasus/Dock-X

Change to the project directory:

cd Dock-X

Install the dependencies:

pip install poetry
poetry install

🤖 Running Dock-X

python __init__.py

🧪 Tests

pytest

🛣 Project Roadmap

ℹ️ Task 1: Implement Kiosk Mode

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

Submit Pull Requests: Review open PRs, and submit your own PRs.
Join the Discussions: Share your insights, provide feedback, or ask questions.
Report Issues: Submit bugs found or log feature requests for 047PEGASUS.

Contributing Guidelines

Click to expand

Fork the Repository: Start by forking the project repository to your GitHub account.
Clone Locally: Clone the forked repository to your local machine using a Git client.
```
git clone <your-forked-repo-url>
```
Create a New Branch: Always work on a new branch, giving it a descriptive name.
```
git checkout -b new-feature-x
```
Make Your Changes: Develop and test your changes locally.
Commit Your Changes: Commit with a clear and concise message describing your updates.
```
git commit -m 'Implemented new feature x.'
```
Push to GitHub: Push the changes to your forked repository.
```
git push origin new-feature-x
```
Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.

📄 License

This project is protected under the SELECT-A-LICENSE License. For more details, refer to the LICENSE file.

👏 Acknowledgments

List any resources, contributors, inspiration, etc. here.

Return