From d127f60a2ffc91136d8715e2e227a1dde177a8b5 Mon Sep 17 00:00:00 2001 From: Tushar Date: Tue, 2 Aug 2022 00:42:01 +0530 Subject: [PATCH 1/3] updated readme --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 96ef661e..6c97e53b 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,22 @@ ``` yarn run dev ``` +... +#How to setup using docker +1. Install Docker Desktop [https://www.docker.com/products/docker-desktop/]. + ``` +2. From the project directory, start up the application by running + ``` + docker compose up +3. compose pulls all the images required ,builds an image for the code, and starts the services. The code is statically copied into the image at build time. + ``` + +4. Enter [http://localhost:8000/](http://localhost:6003)(for serving backend) in a browser to see the application running. + ``` +5. Stop the application, either by running docker compose down from within your project directory in the second terminal, or by hitting CTRL+C in the original terminal where you started the app. + ``` +... ## Contribution guidelines If you are interested in contributing to CloudCV, follow our [contribution guidelines](https://github.com/Cloud-CV/CloudCV/blob/master/.github/CONTRIBUTING.md). From 9fe94dcc6be5a4f1424c4f361cd6890911f78ff9 Mon Sep 17 00:00:00 2001 From: Tushar Date: Tue, 2 Aug 2022 00:47:07 +0530 Subject: [PATCH 2/3] updated the readme --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6c97e53b..2324fa9f 100644 --- a/README.md +++ b/README.md @@ -100,13 +100,14 @@ yarn run dev ``` ... -#How to setup using docker +## How to setup using docker 1. Install Docker Desktop [https://www.docker.com/products/docker-desktop/]. - ``` + ``` 2. From the project directory, start up the application by running ``` docker compose up + ``` 3. compose pulls all the images required ,builds an image for the code, and starts the services. The code is statically copied into the image at build time. ``` From 82b784536a1524451f79abd162e44858e8153066 Mon Sep 17 00:00:00 2001 From: Tushar Kumar Shahi <103762351+Tusharkshahi@users.noreply.github.com> Date: Wed, 3 Aug 2022 01:48:18 +0530 Subject: [PATCH 3/3] Update README.md --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2324fa9f..ef829421 100644 --- a/README.md +++ b/README.md @@ -104,16 +104,15 @@ 1. Install Docker Desktop [https://www.docker.com/products/docker-desktop/]. ``` -2. From the project directory, start up the application by running +2. From the project directory, start up the application by running the given command, compose pulls all the images required ,builds an image for the code, and starts the services. The code is statically copied into the image at build time. ``` docker compose up ``` -3. compose pulls all the images required ,builds an image for the code, and starts the services. The code is statically copied into the image at build time. +3. Enter [http://localhost:8000/](http://localhost:6003)(for serving backend) in a browser to see the application running. ``` - -4. Enter [http://localhost:8000/](http://localhost:6003)(for serving backend) in a browser to see the application running. + http://localhost:8000/ ``` -5. Stop the application, either by running docker compose down from within your project directory in the second terminal, or by hitting CTRL+C in the original terminal where you started the app. +4. Stop the application, either by running docker compose down from within your project directory in the second terminal, or by hitting CTRL+C in the original terminal where you started the app. ``` ... ## Contribution guidelines