Shiloh/frappe_docker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Local Dev Environment Setup

Linden Crandall 2025-01-13 22:43:30 +00:00
parent 2d0a3c017e
commit 4dfdab6aad
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Local-Dev-Environment-Setup.md

@ -11,9 +11,18 @@ In order to start developing you need to satisfy the following prerequisites:
- Dev Containers extension installed for VS Code. [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
## Step-By-Step Setup
- Request access to Shiloh's private `frappe_docker` git repo. Clone and cd to `frappe_docker` dir.
- Request access to Shiloh's private `frappe_docker` git repo. Clone repo:
```
git clone https://githaven.org/Shiloh/frappe_docker.git
```
- Enter your Shiloh git account creds. ex):
```
Cloning into 'frappe_docker'...
Username for 'https://githaven.org': USERNAME
Password for 'https://USERNAME@githaven.org': ************
```
- cd to `frappe_docker` dir:
```
cd frappe_docker
```
- Run:
@ -26,7 +35,8 @@ cp -r development/vscode-example development/.vscode
code .
```
- When VS Code is opened, you should see a pop-up in the bottom right that says: "Reopen In Container". Select that and the dev container will be built and started automatically. If you don't see the pop up, close VS Code and reopen it. Alternatively, open VS Code, open command palette `Ctrl + Shift + P` then search for and select "Reopen in Container" **If this doesn't work, you might not have added your current user to the docker group correctly. This is required and can be tested by running docker commands without sudo i.e. `docker ps`**
- Once the dev container is finished building and you are in the new dev container VS Code window, copy `apps-example.json` to `apps.json`:
- Once the dev container finishes building, you should be in a new VS Code window within the new dev container as the `frappe` user.
- From the terminal in VS Code, copy `apps-example.json` to `apps.json`:
```
cp apps-example.json apps.json
```
@ -46,9 +56,9 @@ cp apps-example.json apps.json
```
- Run `installer.py` with the following flags (read `installer.py` to see what it does and for additional flags):
```
python installer.py -j apps.json -s deverpnext.localhost -p 3.10.13 -v
python installer.py -j apps.json -s development.localhost -p 3.10.13 -v
```
- cd into new frappe-bench folder and start python virtual environment:
- After `installer.py` finishes, cd into new frappe-bench folder and start python virtual environment:
```
cd frappe-bench
. env/bin/activate