mirror of
https://github.com/frappe/frappe_docker.git
synced 2024-11-08 14:21:05 +00:00
fix: make docs more explicit for beginners (#1409)
This commit is contained in:
parent
855c4f62cc
commit
281c072e77
23
README.md
23
README.md
@ -6,21 +6,34 @@ Everything about [Frappe](https://github.com/frappe/frappe) and [ERPNext](https:
|
|||||||
# Getting Started
|
# 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).
|
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:
|
||||||
|
|
||||||
|
<a href="https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/frappe/frappe_docker/main/pwd.yml">
|
||||||
|
<img src="https://raw.githubusercontent.com/play-with-docker/stacks/master/assets/images/button.png" alt="Try in PWD"/>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
### Try on your Dev environment
|
||||||
|
|
||||||
|
First clone the repo:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git clone https://github.com/frappe/frappe_docker
|
git clone https://github.com/frappe/frappe_docker
|
||||||
cd frappe_docker
|
cd frappe_docker
|
||||||
```
|
```
|
||||||
|
|
||||||
### Try in Play With Docker
|
Then run: `docker compose -f pwd.yml -d`
|
||||||
|
|
||||||
<a href="https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/frappe/frappe_docker/main/pwd.yml">
|
## Final steps
|
||||||
<img src="https://raw.githubusercontent.com/play-with-docker/stacks/master/assets/images/button.png" alt="Try in PWD"/>
|
|
||||||
</a>
|
|
||||||
|
|
||||||
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`)
|
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
|
# Documentation
|
||||||
|
|
||||||
### [Production](#production)
|
### [Production](#production)
|
||||||
|
Loading…
Reference in New Issue
Block a user