[FEATURE] Add Docker Compose Support and Update Documentation

[abhayymishraa]

Why do we need this improvement?

The project currently includes a Dockerfile for containerizing the application, but lacks a docker-compose.yml. Docker Compose would greatly enhance the usability of the project by providing an easy, consistent way to manage multi-container setups.

Additionally, by attaching volumes, developers can benefit from real-time code synchronization between their local file system and the running container. This eliminates the need to rebuild the container every time code changes, significantly improving development speed and reducing friction.

How will this change help?

Simplify Setup:

1. Users can spin up the entire environment with a single docker-compose up command.

2. Volumes will enable real-time code updates without the need to rebuild the container, creating a smoother development process.
   Ideal for developers who want to work on the project without worrying about container lifecycle management.

3. By lowering the barrier to entry for new contributors through simplified setup and better tooling, the project can attract a wider developer base.

4. Documentation updates will ensure contributors have clear instructions for using Docker Compose, making the project more accessible to all.

Screenshots

No response

How could it be implemented/designed?

By creating a docker-compose.yml in the project and attach it with the current Dockerfile and then implement the docker-compose.yml

🚧 Breaking changes

No

👀 Have you checked for similar open issues?

• I checked and didn't find a similar issue

🏢 Have you read the Contributing Guidelines?

• I have read the Contributing Guidelines

Are you willing to work on this issue?

Yes I am willing to submit a PR!

[github-actions]

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[abhayymishraa]

Shall i wait for maintainers to assign it to me or should i make a pr without getting assigned

[SahilDahekar]

@abhayymishraa i dont see a need for docker-compose . The Dockerfile already is pretty basic - just runs the nextjs app no db connections as well.

[abhayymishraa]

Hey @SahilDahekar ,

I get your point, but here’s why I think adding a docker-compose.yml could really help:

1. Makes it super easy to spin everything up with just docker-compose up.
2. Lets developers see code changes instantly in the container with volumes—no need to rebuild every time.
3. Prepares the project for future services like a database or cache if needed.
4. New contributors can get started without worrying about manual commands.
5. Ensures everyone works in the same environment, avoiding setup issues.

What do you think? 😊

[SahilDahekar]

All these features are good but doesnt really make a difference at this point . Maybe other issues can have more impact . Think of it .

Btw , issues are not assigned here you can start contributing and make a PR . But just verify with a maintainer if they need this change .

[abhayymishraa]

Bro think it this way, if this project have a Dockerfile even the next js project are so easy to set up still we have a Dockerfile let's say a developer who is using Dockerfile for their development process they have to make docker build and run every time to show changes .I think its heptic .
But if we can use docker-compose.yml what we really need is just docker-compose up to run and also it provide real time development using volumes. So the developers also not need to rebuild and run for all the changes as it will be time consuming.
Btw Thank You so much for the Info . I will definately discuss with the maintainers.

[Pratikkale26]

Hi, I’ve raised PR #3554 to address this issue by adding a Docker Compose file. Please let me know if there are additional improvements or changes needed. Looking forward to your feedback!

[abhayymishraa]

@Pratikkale26 i was working on it . you've raised a pr without assignment !! Please read Contributing Guidelines

[anshgoyalevil]

I don't see a need for a docker-compose file as there is no separate backend/db that we can combine into a docker-compose.

Also, there's a Dockerfile that does the work. With vscode .devcontainers or WSL2, I don't see a need for Docker volumes as well.