Quickstart Frappe Development

TLDR

Prepare frappe_docker development setup locally and open in VS Code.

pnpm dlx degit frappe/frappe_docker [project_name]
cd [project_name]
rm -rf $(ls -A | grep -Ev "development|devcontainer-example")
mv devcontainer-example .devcontainer
mv development/vscode-example development/.vscode
code .

Re-open in VS Code Devcontainer and execute:

./installer.py

Wait for the script to complete, enter the frappe-bench directory and execute bench start to start development.

cd frappe-bench
bench start

Open: http://development.localhost:8000 to access site. Username is Administrator and password is admin.

Prerequisites

• Linux (Ubuntu latest LTS)
• Docker (curl -fsSL https://get.docker.com | bash)
• Post docker installation steps
• VS Code
• VS Code Devcontainer Extension

Clone frappe_docker and reopen in devcontainer

00-clone-frappe-docker.mp4

Create frappe-bench

Use custom apps.json with ./installer.py -j apps.json

01-create-frappe-bench.mp4

Start bench and open site

02-start-site.mp4

Stop Devcontainers

Stop devcontainers gracefully to avoid any corruption.

03-stop-devcontainers.mp4