Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Addition of docker #2164

Closed
captain-Akshay opened this issue Sep 24, 2023 · 10 comments · Fixed by #2179
Closed

Addition of docker #2164

captain-Akshay opened this issue Sep 24, 2023 · 10 comments · Fixed by #2179

Comments

@captain-Akshay
Copy link
Contributor

Reason/Context

It will help the developers to start the local development without installing the dependency make the development process faster and easy.This will certainly help the contributor to a great extent as docker provide containerization which will not affect there computer and reduce the trouble for running it locally.

Description

Just a Dockerfile would be enough for generating an image and running it locally but to take it even further we can make a docker-compose.yml as well to make it more easy to depoly locally.This will act individually so any problem with the docker container wont affect or interfere the work of nextjs application.
I can work on this !

@github-actions
Copy link

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.

@derberg
Copy link
Member

derberg commented Sep 25, 2023

Dockerfile would make sense imho. I was recently introduced to https://code.visualstudio.com/docs/devcontainers/create-dev-container, maybe that would be best? in the end majority of fronend contributors use VSCode

@captain-Akshay
Copy link
Contributor Author

captain-Akshay commented Sep 25, 2023

Yes indeed and docker helps a lot in frontend development as every now and then i see myself installing older version of node pnpm yarn for better installation and then setting up local database for better engagement with the interface and this can be handled with docker-compose file for setting up this environment with the least resource require!
Now I'm trying to improve my docker skills as well and i would to work for this one as well please let me know your thoughts on this!! @derberg

@derberg
Copy link
Member

derberg commented Sep 26, 2023

docker compose is not needed imho, we just need a dockerfile that will setup things.

the most important is developer experience, how will one use docker image to locally build website, and develop and see results of development

thus I was thinking that maybe dev container is easier to work with 🤔

@captain-Akshay
Copy link
Contributor Author

@derberg I completely agree with you! To address how Docker can be beneficial for a better developer experience:

  • Docker is particularly useful when a newcomer wants to quickly verify if all components are functioning correctly. This is especially valuable during the startup phase when there are numerous code branches to manage.

  • If a developer encounters multiple issues while trying to set up a local development environment on their system but still wishes to contribute, Docker can be a viable alternative. Although it may take more time compared to the traditional setup, it can prove invaluable during times of need.

if you want me to work on this 😊😊 will be more than happy to contribute!

Copy link
Member

derberg commented Sep 26, 2023

and what is your opinion on VSCode and dev container?

@captain-Akshay
Copy link
Contributor Author

honestly i havent tried that but while going through the web i got to know it can work both ways either with there own image and configuration or by dockerfile.
the best thing is that it can work with both vscode and github codespace,
the only de-merit will be i have seen some contributor to use Webstrom
though it might take me time but i think i can create both a dockerfile and a devcontainer.json so that it can cover all grounds!
what do you say?
@derberg

@derberg
Copy link
Member

derberg commented Sep 26, 2023

sounds good to me, but please do it in 2 separate PRs, one at a time. I guess best would be docker as first, as it is more universal

@akshatnema akshatnema linked a pull request Sep 30, 2023 that will close this issue
@akshatnema
Copy link
Member

Hey @derberg @captain-Akshay, after reading your discussion. I've couple of doubts here:

  • Why are we restricting the usage of docker to VS Code Dev containers only? There are multiple IDEs/editors available, why we should give preference to VS Code only?
  • Why the changes in 2 PRs? I want to test the Dockerfile and it requires dockercontainer.json to run in VS Code? We should complete the changes in 1 PR only.

Copy link
Member

derberg commented Oct 2, 2023

  • 2 PRs as Dockerfile can be used without devcontainer and VS Code
  • devcontainer is way to go as this is website, frontend where majority of folks use VS Code. But because we also add a Dockerfile independently, then nobody is forced to use VSCode and devcontainer feature

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants