MLSAKIIT / MLSAKIIT/ComposeGenie

Frontend: Docker Compose File Builder UI

Open
#14 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Backend enhancement Frontend
Dominant language
TypeScript
Stars
4
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Is your feature request related to a problem? Please describe.

Currently, users have to manually edit or create docker-compose.yml files, which can be error-prone and intimidating for beginners.
There is no visual interface in the application to guide users in defining services, ports, volumes, environment variables, and dependencies interactively.

Describe the solution you'd like

Implement a Docker Compose File Builder UI that allows users to visually configure and generate docker-compose.yml files.
The UI should provide:

  • A form-based or drag-and-drop interface for adding and editing services
  • Fields for image name, ports, volumes, environment variables, and networks
  • Real-time YAML preview and validation
  • Export/download functionality for the generated docker-compose.yml
Describe alternatives you've considered
  • Manual YAML editing:
    Functional but not user-friendly, especially for users unfamiliar with Docker Compose syntax.
  • Using external tools (like Docker Desktop or Portainer):
    These provide similar functionality but require users to leave the current platform, breaking workflow consistency.
Use Case

Helps users (especially beginners and students) quickly create valid Docker Compose configurations directly within the platform, improving usability and reducing syntax errors.
Can be integrated with the service catalog to auto-populate images and default configurations for common services.

Additional context
  • Could integrate with the existing ComposeGenie service catalog to auto-fill image details.
  • The generated YAML should comply with Docker Compose v3+ specifications.
  • Preview pane should support syntax highlighting and copy-to-clipboard.
Implementation Considerations
  • 🧱 Use a form-based builder with dynamic service addition/removal
  • 🧩 Integrate YAML preview component for live updates
  • 🧠 Include validation to prevent invalid configurations
  • 📦 Optionally connect with Docker Hub API for image metadata (if available)
  • 💾 Support export and download as docker-compose.yml

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing ComposeGenie service catalog and the current frontend entry points to understand how services and generated Compose files are represented. Define the builder scope, validation behavior, preview, and export requirements before implementation; done means users can configure services and obtain a valid Docker Compose v3+ file.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, docker-compose, typescript
Domain
devops, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.