-
-
Notifications
You must be signed in to change notification settings - Fork 681
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
chore: add docker file #2179
chore: add docker file #2179
Conversation
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-2179--asyncapi-website.netlify.app/ |
Signed-off-by: captain-Akshay <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it is enough to have a dockerfile just for development environment
please update PR by adding to the README and nice copy/paste instruction for contributors that explains how to build and run the image, and develop website alongside, seeing localhost preview regeneration
@derberg Ok sure I will add the documentation for the contributor where they can copy paste to start the docker container instantly |
@captain-Akshay Please make sure you add alpine image installation via docker in the system, using the following command: sudo docker pull alpine Without this pre-requisite command, users will not able to build the website for first time. |
@akshatnema yeah i will make sure i make it as concise as possible maybe add a |
@akshatnema are you sure? docker build works in the way that if image is not present, it pulls it by default |
Signed-off-by: captain-Akshay <[email protected]>
ad9618c
to
842aa2c
Compare
Signed-off-by: captain-Akshay <[email protected]>
I will check once again. Although, when I did locally first time on my system, I got some errors, and after installing alpine, I got no more errors in it. |
|
Signed-off-by: captain-Akshay <[email protected]>
true! i m thinking way ahead sorry @derberg 😅 |
README.md
Outdated
|
||
### For Windows | ||
- `cd` into the repo | ||
- run the command one by one `docker build -t async_image -f Dockerfile.dev .` then `docker run -d -p 3000:3000 async_image` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess we do not need windows specific instructions, right? also dockerfile.dev
no longer here
README.md
Outdated
|
||
- `cd` into the repo | ||
- run the following command `docker build -t async_image -f Dockerfile . && docker run -d -p 3000:3000 async_image` | ||
- Visit localhost:3000 and the website should be live |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, so we know how to build, and how to run, what about development - this part is critical.
I want to run dev environment for development, so I need to run an image mapping local fork of the repo, right? so I can develop in my IDE, make changes, and rebuild and refresh of website is still possible - through docker this time
Signed-off-by: captain-Akshay <[email protected]>
Signed-off-by: captain-Akshay <[email protected]>
@derberg, I must express my admiration for your thought process and consideration of all conceivable scenarios is truly commendable, and I find it to be a valuable learning opportunity. |
README.md
Outdated
|
||
### Steps to start server | ||
|
||
- `cd` into the repo |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of writing instruction cd
into the repo, we can direct users "to go inside the directory of the repo and run the following commands."
Signed-off-by: captain-Akshay <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM ✔️ . @derberg any points remaining?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
left some comments, we need better readme
Co-authored-by: Lukasz Gornicki <[email protected]>
Co-authored-by: Lukasz Gornicki <[email protected]>
Co-authored-by: Lukasz Gornicki <[email protected]>
Co-authored-by: Lukasz Gornicki <[email protected]>
Signed-off-by: captain-Akshay <[email protected]>
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-2179--asyncapi-website.netlify.app/ |
@derberg Your review is required!! |
@derberg ? it would be great if you could ? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfect job, sorry @captain-Akshay for keeping you waiting and 🙏🏼 for your patience
/rtm |
issue #2164
Description