Skip to content

docs: update README to specify correct Docker Compose file (fixes #32) #41

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

Open
Sai-Emani25 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update README to specify correct Docker Compose file (fixes #32) #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,14 @@ cd veren

We assume you have already gone through the required configuration and added the necessary files as described in [@essentials](https://github.com/atithi4dev/veren/blob/main/Docs/GITHUB_SETUP.md) before starting the project.


**Start the services using Docker Compose:**
```bash
docker compose up --build
docker compose -f docker-compose.dev.yml up --build
```
Now you are ready to visit [api-guidelines](https://github.com/atithi4dev/veren/blob/main/Docs/API_DOCUMENTATION.md) to access the differnt routes and supported features.
> **Note:** The default command `docker compose up --build` will fail because there is no root-level `docker-compose.yml`. Make sure to specify the correct file as above.

Now you are ready to visit [api-guidelines](https://github.com/atithi4dev/veren/blob/main/Docs/API_DOCUMENTATION.md) to access the different routes and supported features.

## Architecture Overview -

Expand Down