fix(docs): add prerequisites section in step 2 #1149
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
StanGirard
requested changes
Sep 12, 2023
README.md
Outdated
| ``` | ||
|
|
||
| - **Step 6**: Navigate to `localhost:3000` in your browser | ||
|
|
||
| - **Step 7**: Want to contribute to the project? | ||
|
|
||
| ``` | ||
| docker compose -f docker-compose.dev.yml up --build | ||
| docker-compose -f docker-compose.dev.yml up --build |
There was a problem hiding this comment.
docker-compose is deprecated and has been integrated in docker cli.
|
|
||
| ```bash | ||
| brew install gum # Windows (via Scoop) scoop install charm-gum |
There was a problem hiding this comment.
Please keep this line and add the install for PostgreSQL too for mac and windows
install_helper.sh
Outdated
| @@ -80,7 +80,7 @@ echo "Running the migration scripts..." | |||
|
|
|||
| # Step 5: Launch the app | |||
| echo "Launching the app..." | |||
| docker compose up --build | |||
| docker-compose up --build | |||
There was a problem hiding this comment.
Same here. Keep docker compose separated
…ecessary to perform further steps
gozineb
changed the title
StanGirard
approved these changes
Sep 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I made an example of what requirements are necessary to run the "install_helper" script and to display what its prerequisites are to run.