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

Jump to bottom

chore(doc): add setup section #67

Merged
merged 4 commits into from
Jul 16, 2024
Merged

chore(doc): add setup section #67

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2a9285a
chore(doc): add setup section
MR2011 Jul 11, 2024
d5ebfde
chore(doc): Update README.md
MR2011 Jul 12, 2024
4374f8f
Merge branch 'main' into MR2011-patch-1
MR2011 Jul 12, 2024
2489fe3
Merge branch 'main' into MR2011-patch-1
drochow Jul 16, 2024
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
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,23 @@ For a detailed understanding of the system's architecture and design, refer to t

## Requirements and Setup

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the description, but I think the default way should be using the Makefile no?

Also I think we need to add a couple more information such as environment variables etc.

WDYT?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right. I'll add this

*Insert a short description what is required to get your project running...*
The `docker-compose.yml` file defines two profiles: `db` for the `heureka-db` service and `heureka` for the `heureka-app` service.
To start a specific service with its profile, use the --profile option followed by the profile name.

For example, to start the heureka-db service, run:
```
docker-compose --profile db up
```

And to start the heureka-app service, run:
```
docker-compose --profile heureka up
```

To start both services at the same time, run:
```
docker-compose --profile db --profile heureka up
```

## Support, Feedback, Contributing

Expand Down
Loading