Frappe Development

The Mint System Frappe development environment.

This projects provides a highly opinionated way to develop Frappe sites and apps. It provides three ways to run Frappe.

• Native: Frappe is downloaded to the project folder. Use bench natively to run the development server.
• Docker Production: This approach uses Docker Compose to the setup a Frappe project as it would be running in production.
• Docker Development: The production setup is complex. Use this approach run Frappe Bench within a container.

Requirements

Common:

• bash/zsh alias task='./task' with optional completion

Docker:

• Docker and Docker Compose

Native:

• Install Python 3.6+ with pyenv
• Install Node.js 12+ with n
• Install yarn 1.12+: npm install -g yarn
• wkhtmltopdf: sudo apt install wkhtmltopdf

Usage

Clone this repository.

git clone https://github.com/Mint-System/Frappe-Development.git
cd Frappe-Development

See command overivew with task help or read task.

Check if required tools are installed.

task version

Native

Start Docker database containers.

task start db

Install Frappe dependencies.

task install

Install app.

task install-app uppsala https://gitlab.com/hfmts/uppsala.git

Start frappe development server.

task start native

Docker

Start Docker containers.

task start all

Install app.

task docker-install-app uppsala https://gitlab.com/hfmts/uppsala.git

Docker Development

Start Docker development containers.

task start dev

Install Frappe and setup site.

task docker-install-dev

Start the Docker development server.

task start bench