Skip to content

Commit 9e32dbd

Browse files
committed
feat: add new dev setup and update readme
1 parent 63c20a1 commit 9e32dbd

File tree

3 files changed

+61
-3
lines changed

3 files changed

+61
-3
lines changed

README.md

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![push-docker](https://github.com/pipech/erpnext-docker-debian/actions/workflows/push-docker.yml/badge.svg)
44

5-
**This repository prioritizes stability and repeatability, and is not designed as the ideal approach for a production environment.**
5+
**This repository prioritizes stability, repeatability and simplicity, and is not designed as the ideal approach for a production environment.**
66

77
## Problem
88

@@ -14,9 +14,51 @@
1414

1515
By using Docker, we can pre-build images and push them to [Docker hub](https://hub.docker.com/r/pipech/erpnext-docker-debian/). This ensures that usable images are always available, and you can select the version that best suits your needs.
1616

17-
## Setup
17+
## User & Password
1818

19-
Read [the Docs](https://github.com/pipech/erpnext-docker-debian/wiki)
19+
```
20+
# Website
21+
U: administrator
22+
P: 12345
23+
24+
# MariaDB
25+
U: root
26+
P: 12345
27+
```
28+
29+
## Usage
30+
31+
### Trial Setup
32+
33+
This setup is designed for users who want to explore the system and is not suitable for production use.
34+
35+
```sh
36+
docker pull pipech/erpnext-docker-debian:version-15-latest
37+
38+
docker run -d -p 8000:8000 -p 9000:9000 -p 3306:3306 pipech/erpnext-docker-debian:version-15-latest
39+
```
40+
41+
The site should be available at http://localhost:8000 after 1-2 minutes.
42+
43+
### Development Setup
44+
45+
This is a self-contained development setup. Developers can fully isolate their environment. The setup utilizes Visual Studio Code and its Dev Containers feature.
46+
47+
1. Open Visual Studio Code.
48+
1. Open the Command Palette (View > Command Palette or Ctrl + Shift + P).
49+
1. Type: `Open Folder in Container`.
50+
1. Select the `setup_development` folder.
51+
52+
For every startup, run:
53+
54+
```sh
55+
sudo service mariadb start
56+
bench start
57+
```
58+
59+
### Production Setup
60+
61+
For best practices in a production environment, [Official Frappe Docker](https://github.com/frappe/frappe_docker).
2062

2163
## Build Process
2264

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"name": "frappe",
3+
"service": "frappe",
4+
"dockerComposeFile": "docker-compose.yml",
5+
"workspaceFolder": "/home/frappe/bench/apps"
6+
}
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: '3'
2+
3+
services:
4+
frappe:
5+
image: pipech/erpnext-docker-debian:15-F1.0_E2.0
6+
ports:
7+
- '8000:8000' #webserver_port
8+
- '9000:9000' #socketio_port
9+
- '3306:3306' #mysql_port
10+
command: sleep infinity

0 commit comments

Comments
 (0)