From c03c94197e7e4668f6b5de7b9ea46d7b0dbf993f Mon Sep 17 00:00:00 2001 From: Chev91 Date: Sun, 9 Jun 2024 13:28:47 +0200 Subject: [PATCH] fix: make docs more explicit for beginners --- README.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 43816c84..4998d3bd 100644 --- a/README.md +++ b/README.md @@ -6,21 +6,34 @@ Everything about [Frappe](https://github.com/frappe/frappe) and [ERPNext](https: # Getting Started To get started you need [Docker](https://docs.docker.com/get-docker/), [docker-compose](https://docs.docker.com/compose/), and [git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git) setup on your machine. For Docker basics and best practices refer to Docker's [documentation](http://docs.docker.com). -After that, clone this repo: + +Once completed, chose one of the following two sections for next steps. + +### Try in Play With Docker + +To play in an already set up sandbox, in your browser, click the button below: + + + Try in PWD + + +### Try on your Dev environment + +First clone the repo: ```sh git clone https://github.com/frappe/frappe_docker cd frappe_docker ``` -### Try in Play With Docker +Then run: `docker compose -f pwd.yml -d` - - Try in PWD - +## Final steps Wait for 5 minutes for ERPNext site to be created or check `create-site` container logs before opening browser on port 8080. (username: `Administrator`, password: `admin`) +If you ran in a Dev Docker environment, to view container logs: `docker compose -f pwd.yml -d`. Don't worry about some of the initial error messages, some services take a while to become ready, and then they go away. + # Documentation ### [Production](#production)