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

Readme updated #267

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Readme updated #267

wants to merge 2 commits into from

Conversation

DiegoICid
Copy link

@DiegoICid DiegoICid commented Jul 6, 2022

Just updated the Readme file to simplify Docker installation guidelines, and add other helpful resources for new contributors at "#6 Contributing"


This change is Reviewable

@netlify
Copy link

netlify bot commented Jul 6, 2022

👷 Deploy request for dreamy-keller-b8ad36 pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit f83fba8

@gitpod-io
Copy link

gitpod-io bot commented Jul 6, 2022

Copy link
Contributor

@codecakes codecakes left a comment

Choose a reason for hiding this comment

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

Overall new information looks good but we need to update the existing information as well.

@@ -61,14 +62,23 @@ Update any relevant keys in your new .env file. For example, if you will be work

Please note: Any time you change the values in this .env file, you will need to stop and restart your Docker container in order for the new values to take effect.

#### Install Docker Compose on Mac
#### Install Docker Desktop
Copy link
Contributor

Choose a reason for hiding this comment

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

thanks for adding. why do you think "Install Docker Compose on Mac" should be removed?


- If using Windows, before installing Docker Desktop make sure you have installed WSL (Windows Subsystem for Linux). Else, install WSL first: https://docs.microsoft.com/en-us/windows/wsl/install
- Click https://docs.docker.com/desktop/, to start to install Docker Desktop.
- In the left sidebar, choose between Mac or Windows installation and follow the instructions.
Copy link
Contributor

Choose a reason for hiding this comment

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

There are now installations for *nix, win & mac likewise. Maybe this information can be explored and added here.

- Click Get Docker to download docker and run Docker.dmg
- Install docker compose using PIP in command line: pip install -U docker-compose
- Run docker-image to start instance:
#### Install Docker Compose
Copy link
Contributor

Choose a reason for hiding this comment

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

*nix users may need to additionally have docker compose. can you confirm on their site?

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