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.

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

Merged
merged 4 commits into from
Jul 16, 2024
Merged

chore(doc): add setup section #67

merged 4 commits into from
Jul 16, 2024

Conversation

MR2011
Copy link
Collaborator

@MR2011 MR2011 commented Jul 11, 2024

No description provided.

@MR2011 MR2011 requested a review from drochow as a code owner July 11, 2024 14:02
@@ -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

Comment on lines +60 to +61

DOCKER_CREDENTIAL_STORE=docker-credential-desktop
Copy link
Collaborator

Choose a reason for hiding this comment

The 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
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this is not a self-explanatory env var


LOCAL_TEST_DB=true

SEED_MODE=false
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this is not a self-explanatory env var

@drochow drochow merged commit 9259492 into main Jul 16, 2024
2 of 3 checks passed
@drochow drochow deleted the MR2011-patch-1 branch July 16, 2024 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants