Updates Readme.md file for better documentation and Edited docker-compose.yml with correct path#61
Merged
developersdigest merged 2 commits intodevelopersdigest:mainfrom Sep 4, 2024
Conversation
…pose.yml with correct path.
…pose.yml with correct path.
This file contains hidden or 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
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.
I made two changes to the repository:
Readme.mdfile: I made changes to the Readme.md file, which is a Markdown file that typically contains information about the project, such as its purpose, usage, and setup instructions. The update was made to improve the documentation.docker-compose.ymlfile: I made changes to the docker-compose.yml file, which is a configuration file used by Docker Compose to define and run multi-container Docker applications. The edit was made to correct the path in the file.In Readme.md, I have also added the Installation method using Docker. So users who dont want to install Node or npm or local machine can directly deploy it with docker compose.
Although The
docker-compose.ymlwas already present in the repo. The proper installation method was not shown.In Docker Compose, a volume mount is used to mount a directory from the host machine to a directory inside a container. The syntax for a volume mount is:
|
<host-path>:<container-path>:<options>In your case, the original line was:
And it was changed to:
Here's what changed:
The host path ($PWD/config.tsx) was changed to ($PWD/app/config.tsx), which means the file is now being mounted from a correct location on the host machine.
The container path (/home/node/app/config/config.tsx) was changed to (/home/node/app/app/config.tsx), which means the file is now being mounted to a correct location inside the container.