[Skip to content](#main)

[→](/)

[![Avunu](/brand/avunu-logo.svg)![Avunu](/brand/avunu-logo-light.svg)](/)[Services](/services/)[Consulting](/services/consulting/)[ERP](/services/erp/)[Odoo](/services/erp/odoo/)[ERPNext](/services/erp/erpnext/)[Custom software](/services/custom-software/)[Devices & IoT](/services/devices-iot/)[Websites](/services/websites/)[Infrastructure](/services/infrastructure/)[Partners](/partners/)

[Work](/work/)[Open source](/open-source/)[Knowledge base](/kb/)[About](/about/)

[About Avunu](/about/)[Team](/about/team/)[Insights](/insights/)[Contact](/contact/)

[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

- [Services](/services/)[Consulting](/services/consulting/)
- [ERP](/services/erp/)
- [Odoo](/services/erp/odoo/)
- [ERPNext](/services/erp/erpnext/)
- [Custom software](/services/custom-software/)
- [Devices & IoT](/services/devices-iot/)
- [Websites](/services/websites/)
- [Infrastructure](/services/infrastructure/)
- [Partners](/partners/)

[Work](/work/)[Open source](/open-source/)[Knowledge base](/kb/)[About](/about/)

- [About Avunu](/about/)
- [Team](/about/team/)
- [Insights](/insights/)
- [Contact](/contact/)

[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

[Knowledge base](/kb/)Frappe

Search the knowledge basePress/

ESC

Jump to

[Browse the knowledge base](/kb/)[Frappe](/kb/frappe/)[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

↵select↑↓navigateescclose

Search the knowledge base

[Skip to the article](#kb-article)[Frappe](/kb/frappe/)20 articles

- [Overview](/kb/frappe/)
- [Bench Operations](/kb/frappe/bench-operations/)
- [Builder Page Scripts](/kb/frappe/builder-page-scripts/)
- [Client-Side Recipes](/kb/frappe/client-side-recipes/)
- [Common Query Patterns](/kb/frappe/common-query-patterns/)
- [Custom Field Controllers](/kb/frappe/custom-field-controllers/)
- [Custom Pages](/kb/frappe/custom-pages/)
- [Custom Views](/kb/frappe/custom-views/)
- [Customizations API](/kb/frappe/customizations-api/)
- [Customizing Grid Columns for Child Tables](/kb/frappe/customizing-grid-columns-child-tables/)
- [Doctype States & Status Fields](/kb/frappe/doctype-states-status-fields/)
- [Grandchild Table Fields](/kb/frappe/grandchild-table-fields/)
- [Portal Views](/kb/frappe/portal-views/)
- [Project Structure & Hooks](/kb/frappe/project-structure-hooks/)
- [Query Builder & PyPika Extensions](/kb/frappe/query-builder-pypika/)
- [Quick Entry Forms](/kb/frappe/quick-entry-forms/)
- [Script Reports](/kb/frappe/script-reports/)
- [Testing on Live Databases](/kb/frappe/testing-live-databases/)
- [Type Annotations & Controller Overrides](/kb/frappe/type-annotations-controller-overrides/)
- [Vite & TypeScript Compilation](/kb/frappe/vite-typescript-compilation/)
- [Web Forms](/kb/frappe/web-forms/)

Other sections[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

In Frappe: 20 articles

[Overview](/kb/frappe/)[Bench Operations](/kb/frappe/bench-operations/)[Builder Page Scripts](/kb/frappe/builder-page-scripts/)[Client-Side Recipes](/kb/frappe/client-side-recipes/)[Common Query Patterns](/kb/frappe/common-query-patterns/)[Custom Field Controllers](/kb/frappe/custom-field-controllers/)[Custom Pages](/kb/frappe/custom-pages/)[Custom Views](/kb/frappe/custom-views/)[Customizations API](/kb/frappe/customizations-api/)[Customizing Grid Columns for Child Tables](/kb/frappe/customizing-grid-columns-child-tables/)[Doctype States & Status Fields](/kb/frappe/doctype-states-status-fields/)[Grandchild Table Fields](/kb/frappe/grandchild-table-fields/)[Portal Views](/kb/frappe/portal-views/)[Project Structure & Hooks](/kb/frappe/project-structure-hooks/)[Query Builder & PyPika Extensions](/kb/frappe/query-builder-pypika/)[Quick Entry Forms](/kb/frappe/quick-entry-forms/)[Script Reports](/kb/frappe/script-reports/)[Testing on Live Databases](/kb/frappe/testing-live-databases/)[Type Annotations & Controller Overrides](/kb/frappe/type-annotations-controller-overrides/)[Vite & TypeScript Compilation](/kb/frappe/vite-typescript-compilation/)[Web Forms](/kb/frappe/web-forms/)

Other sections[ERPNext](/kb/erpnext/)[Odoo](/kb/odoo/)[WordPress](/kb/wordpress/)[NixOS](/kb/nixos/)[Email](/kb/email/)[Linux](/kb/linux/)[Databases](/kb/databases/)[Containers](/kb/containers/)[Proxmox](/kb/proxmox/)[Git & Dev Tools](/kb/git-and-dev-tools/)

SectionFrappe Framework and ERPNext

Building on the Frappe framework and ERPNext: bench operations, hooks, custom pages and views, reports, client scripts, query patterns, and testing.

Articles20

UpdatedOct 1, 2026

On this page[Getting Started](#getting-started)[Avunu Conventions](#avunu-conventions)[Foundation](#foundation)[Customizations](#customizations)[Server-Side](#server-side)[Client-Side](#client-side)[Frontend Integration](#frontend-integration)[Web & Portals](#web-portals)[Operations](#operations)

This section collects Avunu's development conventions, code recipes, and server procedures for Frappe Framework and ERPNext.

## Getting Started

The [Frappe official docs](https://docs.frappe.io/framework/user/en/introduction) are a great starting point.

## Avunu Conventions

Frappe is already quite featureful and opinionated, but we have our own (mostly-officially-undocumented) conventions.

### Foundation

[Project Structure & Hooks](/kb/frappe/project-structure-hooks/) — App layout, `hooks.py` configuration, bundle naming, and module organization.

[Type Annotations & Controller Overrides](/kb/frappe/type-annotations-controller-overrides/) — Strong typing with `DF.*`, `cast`, `TypedDict`, and `TYPE_CHECKING` patterns.

### Customizations

[Customizations API](/kb/frappe/customizations-api/) — Overriding doctypes from other apps via hand-crafted JSON + Python controller pairs.

[Doctype States & Status Fields](/kb/frappe/doctype-states-status-fields/) — The undocumented correlation between `status` fields, `workflow_state`, and the `states` array.

### Server-Side

[Query Builder & PyPika Extensions](/kb/frappe/query-builder-pypika/) — Advanced PyPika usage: custom functions, JSON aggregation, nested set depth, correlated subqueries, and derived tables.

[Common Query Patterns](/kb/frappe/common-query-patterns/) — Everyday reads with `frappe.get_all`, the client-side `frappe.db` helpers, child table filters, and `set_query` for Link fields.

[Script Reports](/kb/frappe/script-reports/) — Tree reports, editable reports, external SQL/columns, chart generation, conditional formatting, and toolbar actions.

[Testing on Live Databases](/kb/frappe/testing-live-databases/) — Integration tests with commit suppression, side-effect patching, and guaranteed rollback.

### Client-Side

[Custom Field Controllers](/kb/frappe/custom-field-controllers/) — Extending and overriding built-in field types (e.g., Fraction input for Float fields).

[Custom Views](/kb/frappe/custom-views/) — Adding or replacing ListView implementations with entirely new interfaces.

[Quick Entry Forms](/kb/frappe/quick-entry-forms/) — Custom dialog forms for efficient data entry with multi-document creation.

[Grandchild Table Fields](/kb/frappe/grandchild-table-fields/) — Rendering editable tables inside child table row forms using JSON storage.

[Customizing Grid Columns for Child Tables](/kb/frappe/customizing-grid-columns-child-tables/) — Forcing custom column sets per parent doctype for shared child tables.

[Client-Side Recipes](/kb/frappe/client-side-recipes/) — Small desk snippets: filling a dialog Select from a query and pushing realtime messages from Python to the browser.

### Frontend Integration

[Vite & TypeScript Compilation](/kb/frappe/vite-typescript-compilation/) — Building Vue/TS applications with Vite and integrating compiled assets into Frappe endpoints.

[Custom Pages](/kb/frappe/custom-pages/) — Loading standalone applications (Declarative DOM, Vue, etc.) on Frappe Page doctypes.

### Web & Portals

[Web Forms](/kb/frappe/web-forms/) — Public data entry forms with custom server-side context loading, client-side validation, and payment integration.

[Portal Views](/kb/frappe/portal-views/) — Authenticated list-mode web forms for displaying data history with sidebar navigation.

[Builder Page Scripts](/kb/frappe/builder-page-scripts/) — URL-driven filters on Frappe Builder pages, backed by a Python data script.

### Operations

[Bench Operations](/kb/frappe/bench-operations/) — Backup and restore, switching app remotes, branches, and major versions, bench console data fixes, and schema repair.

Need help with Frappe?

Our notes can take you a long way, but sometimes you'd rather have someone who's done it before.

[ERPNext implementation](/services/erp/erpnext/)

CC0This section is in the public domain ([CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/)), code samples included. Use it however helps you.

On this page

- [Getting Started](#getting-started)
- [Avunu Conventions](#avunu-conventions)
- [Foundation](#foundation)
- [Customizations](#customizations)
- [Server-Side](#server-side)
- [Client-Side](#client-side)
- [Frontend Integration](#frontend-integration)
- [Web & Portals](#web-portals)
- [Operations](#operations)

[Back to top↑](#top)

Services

- [ERP implementation](/services/erp/)
- [Odoo](/services/erp/odoo/)
- [ERPNext](/services/erp/erpnext/)
- [Custom software](/services/custom-software/)
- [Devices & IoT](/services/devices-iot/)
- [Websites](/services/websites/)
- [Infrastructure](/services/infrastructure/)

Resources

- [Our work](/work/)
- [Open source](/open-source/)
- [Knowledge base](/kb/)
- [Insights](/insights/)

Company

- [About](/about/)
- [Team](/about/team/)
- [Partners](/partners/)
- [Contact](/contact/)

Clients

- [Project portal](https://erp.avunu.net/projects)
- [Invoices](https://erp.avunu.net/)
- [Support](https://erp.avunu.net/)

[![Avunu](/brand/avunu-logo-light.svg)](/)[\<av-icon data-jx-static>\<svg viewBox="0 0 24 24" width="20" height="20" fill="currentColor" stroke="none" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" focusable="false">\<path d="M20.400 20.500h-3.600v-5.600c0-1.300 0-3-1.800-3s-2.100 1.400-2.100 2.900v5.700H9.400V9h3.400v1.600c.5-.9 1.600-1.900 3.400-1.900 3.600 0 4.300 2.400 4.300 5.500v6.300zM5.300 7.400a2.100 2.100 0 1 1 0-4.100 2.100 2.100 0 0 1 0 4.100zm1.800 13.100H3.600V9h3.500v11.500zM22.200 0H1.800C.8 0 0 .8 0 1.700v20.600c0 .9.800 1.700 1.800 1.700h20.400c1 0 1.800-.8 1.800-1.700V1.700C24 .8 23.200 0 22.200 0z">\</path>\</svg>\</av-icon>](https://www.linkedin.com/company/avunu)[\<av-icon data-jx-static>\<svg viewBox="0 0 24 24" width="20" height="20" fill="currentColor" stroke="none" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" focusable="false">\<path d="M12 .3a12 12 0 0 0-3.8 23.4c.6.1.8-.3.8-.6v-2c-3.3.7-4-1.6-4-1.6-.6-1.4-1.4-1.8-1.4-1.8-1-.7.1-.7.1-.7 1.2.1 1.8 1.2 1.8 1.2 1 1.8 2.8 1.3 3.5 1 .1-.8.4-1.3.7-1.6-2.7-.3-5.5-1.3-5.5-5.9 0-1.3.5-2.4 1.2-3.2-.1-.3-.5-1.5.1-3.2 0 0 1-.3 3.3 1.2a11.500 11.500 0 0 1 6 0c2.300-1.500 3.300-1.200 3.300-1.200.6 1.700.2 2.900.1 3.200.8.8 1.200 1.900 1.200 3.200 0 4.600-2.800 5.600-5.500 5.900.4.400.8 1.100.8 2.200v3.300c0 .3.2.7.8.6A12 12 0 0 0 12 .3">\</path>\</svg>\</av-icon>](https://github.com/Avunu)[Client portal](https://erp.avunu.net/projects)[Start a project](/start/)

Avunu LLC · 948 East Philadelphia Street, York, PA 17403 · (717) 814-8540Knowledge base articles are in the public domain[Privacy](/privacy/)[Terms](/terms/)
