-
Notifications
You must be signed in to change notification settings - Fork 1
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(doc): add setup section #67
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -40,7 +40,60 @@ For a detailed understanding of the system's architecture and design, refer to t | |
|
||
## Requirements and Setup | ||
|
||
*Insert a short description what is required to get your project running...* | ||
The application can be configured using environment variables. These variables are stored in a `.env` file at the root of the project. | ||
For configuring tests, there is a separate `.test.env` file. | ||
|
||
Here's a basic example of what the .env file could look like: | ||
|
||
``` | ||
DB_USER=my_username | ||
DB_PASSWORD=my_password | ||
DB_ROOT_PASSWORD=my_password | ||
DB_NAME=heureka | ||
DB_ADDRESS=localhost | ||
DB_PORT=3306 | ||
DB_SCHEMA=internal/database/mariadb/init/schema.sql | ||
|
||
DB_CONTAINER_IMAGE=mariadb:latest | ||
|
||
DOCKER_IMAGE_REGISTRY=hub.docker.com | ||
|
||
DOCKER_CREDENTIAL_STORE=docker-credential-desktop | ||
Comment on lines
+60
to
+61
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this is not a self-explanatory env var, lets add some context with a comment? |
||
|
||
LOG_PRETTY_PRINT=true | ||
|
||
LOCAL_TEST_DB=true | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this is not a self-explanatory env var |
||
|
||
SEED_MODE=false | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this is not a self-explanatory env var |
||
``` | ||
|
||
### Docker | ||
|
||
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 | ||
``` | ||
|
||
### Makefile | ||
|
||
Alternatively, the application can be started by using the provided Makefile: | ||
|
||
``` | ||
make start-all-heureka | ||
``` | ||
|
||
## Support, Feedback, Contributing | ||
|
||
|
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 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?
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.
You're right. I'll add this