keploy / keploy/keploy

[feature]: Dockerfile and docker-compose support for S3-Keploy quickstart

Open
#3,505 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement samples-go
Dominant language
Go
Stars
18.5k
Forks
2.4k
Avg merge
1d 4h
Merged PRs (30d)
101

Description

👀 Is there an existing feature request for this?
  • I have searched the existing issues
🔖 Enhancement description

Description

The S3-Keploy quickstart currently lacks Docker and Docker Compose support, making it harder for contributors to run the sample without manual Go installation and setup. Most other quickstarts in the repository (gin-mongo, echo-sql, mux-sql, fasthttp-postgres, etc.) have Docker support, but S3-Keploy is missing these files.

Current Situation

  • ❌ No Dockerfile present
  • ❌ No docker-compose.yml file
  • ❌ README only covers manual setup on Ubuntu
  • ✅ Application code is complete and functional

Proposed Solution

Add Docker support similar to other quickstarts in the repository:

  1. Dockerfile - Multi-stage build following the pattern used in fasthttp-postgres and other samples
  2. docker-compose.yml - Service configuration with AWS credentials volume mounting
  3. README updates - Add "Running app using Docker" section with clear instructions
🎤 Why should this be worked on?

The S3-Keploy quickstart currently lacks Docker and Docker Compose support, making it harder for contributors to run the sample without manual Go installation and setup. Most other quickstarts in the repository (gin-mongo, echo-sql, mux-sql, fasthttp-postgres, etc.) have Docker support, but S3-Keploy is missing these files.

💻 Repository

samples-go

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

Inspect the S3-Keploy quickstart README and compare its setup with the fasthttp-postgres and other Docker-enabled samples. Add the requested Dockerfile and docker-compose.yml, then document Docker-based startup in the README, including the AWS credentials volume setup described in the issue. Done means contributors can run the quickstart without manually installing Go.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, docker, docker-compose, go
Domain
devops, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.