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.

Sign up for GitHub

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

updated readme #177

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

updated readme #177

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d127f60
updated readme
Tusharkshahi Aug 1, 2022
9fe94dc
updated the readme
Tusharkshahi Aug 1, 2022
82b7845
Update README.md
Tusharkshahi Aug 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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. Enter [http://localhost:8000/](http://localhost:6003)(for serving backend) in a browser to see the application running.
```
http://localhost:8000/
```
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

If you are interested in contributing to CloudCV, follow our [contribution guidelines](https://github.com/Cloud-CV/CloudCV/blob/master/.github/CONTRIBUTING.md).