[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](/kb/frappe/)Custom Pages

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/)

FrappeCustom Pages

Load standalone Vue, React, or Declarative DOM applications on Frappe Page doctypes inside the desk.

UpdatedMar 13, 2026

Tagsfrappepagesjavascriptvue

Reading time4 min

On this page[Page Setup](#page-setup)[Page DocType Definition](#page-doctype-definition)[Page JSON](#page-json)[Empty Python File](#empty-python-file)[Mounting the Application](#mounting-the-application)[Entry Point Pattern](#entry-point-pattern)[With Vue](#with-vue)[With Declarative DOM](#with-declarative-dom)[Frappe Realtime Integration](#frappe-realtime-integration)[Server-Side API Endpoints](#server-side-api-endpoints)[External SQL Files](#external-sql-files)[Build Pipeline](#build-pipeline)[Rollup (Simple, No Vue SFCs)](#rollup-simple-no-vue-sfcs)[Development with Live Reload](#development-with-live-reload)[Frappe Page API](#frappe-page-api)

Load standalone applications (Vue, Declarative DOM, React, etc.) on Frappe Page doctypes. Pages provide a blank canvas within the Frappe desk, with access to the full Frappe client API.

## Page Setup

### Page DocType Definition

Create a Page via the standard module structure:

```text
mymodule/page/my_page/
├── __init__.py           # Server-side API endpoints
├── my_page.py            # Empty file (required by Frappe for Page registration)
├── my_page.json          # Page definition
├── my_page.js            # Built bundle (output from build tool)
├── package.json          # Node dependencies (optional, for build step)
├── rollup.config.mjs     # Build configuration (or vite.config.ts)
├── my_query.sql          # External SQL files (optional)
└── src/
    ├── index.mjs         # Entry point
    ├── my_page.mjs       # Root component
    └── components/
        ├── global/       # Reusable components
        └── local/        # Page-specific components
```

### Page JSON

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">{</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"doctype"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Page"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"my-page"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"page_name"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"my-page"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"My Page"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"module"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"My Module"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"standard"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Yes"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"roles"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: [</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"role"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Sales Manager"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">},</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        {</span><span style="--shiki-dark:#7EE787;--shiki-light:#116329">"role"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Sales User"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    ]</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
```

### Empty Python File

`my_page.py` must exist (even if empty) for Frappe to register the page:

```
<span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Required for Frappe page registration</span>
```

## Mounting the Application

### Entry Point Pattern

The entry point hooks into Frappe's page lifecycle:

```
<span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// src/index.mjs</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.pages[</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"my-page"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">].</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">on_page_load</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">function</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> (</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">wrapper</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// Create the Frappe page container</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">var</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> page </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.ui.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">make_app_page</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">({</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        parent: wrapper,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        title: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"My Page"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        single_column: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">true</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    });</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// Mount your application into page.main</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">mountApp</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(page.main[</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">0</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">]);</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">};</span>
```

`page.main[0]` is the raw DOM element where your app should render.

### With Vue

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> { createApp } </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"vue"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">;</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> MyApp </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"./MyApp.vue"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">;</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> { FrappeUI } </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"frappe-ui"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">;</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.pages[</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"my-page"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">].</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">on_page_load</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">function</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> (</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">wrapper</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">var</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> page </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.ui.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">make_app_page</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">({</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        parent: wrapper,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        title: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"My Page"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        single_column: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">true</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    });</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">const</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">app</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">createApp</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(MyApp);</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    app.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">use</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(FrappeUI);</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    app.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">mount</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(page.main[</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">0</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">]);</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">};</span>
```

### With Declarative DOM

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> DDOM </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"@declarative-dom/lib"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">;</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> myPageComponent </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"./my_page"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">;</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.pages[</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"my-page"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">].</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">on_page_load</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">function</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> (</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">wrapper</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">var</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> page </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.ui.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">make_app_page</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">({</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        parent: wrapper,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        title: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"My Page"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        single_column: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">true</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    });</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">try</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">DDOM</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">adoptNode</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(myPageComponent, page.main[</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">0</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">]);</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    } </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">catch</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> (error) {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        console.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">error</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Error initializing page:"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, error);</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    }</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">};</span>
```

## Frappe Realtime Integration

Listen for server-side progress updates:

```
<span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// Client: listen for events</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.realtime.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">on</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"my_progress"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, (</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">data</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=></span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    frappe.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">show_progress</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        data.title,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        data.progress,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        data.total,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">`Current: ${</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">data</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">.</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">current_item</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">}`</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    );</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">if</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> (data.progress </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">>=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> data.total) {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        frappe.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">hide_progress</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">();</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    }</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">});</span>
```

```
<span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># Server: publish events</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe</span>

<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.publish_realtime(</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"my_progress"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"title"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"Processing Quotes"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"progress"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: i,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"total"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: total,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"current_item"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: item_name,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">user</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">frappe.session.user,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
```

## Server-Side API Endpoints

Place whitelisted API functions in `__init__.py`:

```
<span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># mymodule/page/my_page/__init__.py</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> json</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> pathlib </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> Path</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">from</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> typing </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> Any, TypedDict</span>

<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">import</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe</span>

<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">class</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">ProductOption</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">TypedDict</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">):</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    item_code: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    item_name: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    attributes: dict[</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">]</span>

<span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">@frappe.whitelist</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">()</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">def</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">get_product_variants</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(item_code: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) -> list[ProductOption]:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"""Load and execute an external SQL query."""</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    query </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> (Path(</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">__file__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">).parent </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">/</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"variants.sql"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">).read_text()</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    raw </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.db.sql(query, {</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"item_code"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: item_code}, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">as_dict</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">True</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">return</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> json.loads(raw[</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">0</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">][</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"result"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">]) </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">if</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> raw </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">else</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> []</span>

<span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">@frappe.whitelist</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">()</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">def</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">create_proposal_with_quotes</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    combinations_data: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    customer_name: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    sales_partner: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">str</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">) -> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">dict</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">:</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"""Create a proposal and multiple linked quotes."""</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    combinations </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> json.loads(combinations_data)</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781"># ... creation logic</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">return</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> {</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"status"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"success"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"proposal"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: proposal.name}</span>
```

## External SQL Files

Complex queries live in separate `.sql` files:

```text
my_page/
├── bom_template_options.sql    # CTE query returning JSON
├── item_hierarchy.sql          # Nested set hierarchy query
└── variants.sql                # Variant attributes query
```

Load and execute:

```
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">query </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> (Path(</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">__file__</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">).parent </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">/</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"variants.sql"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">).read_text()</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">result </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> frappe.db.sql(query, {</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"item_code"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">: item_code}, </span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">as_dict</span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">True</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">)</span>
```

## Build Pipeline

### Rollup (Simple, No Vue SFCs)

```
<span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// rollup.config.mjs</span>
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">export</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">default</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800"> {</span>
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">    </span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">input: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"src/index.mjs"</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">,</span>
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">    </span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">output: {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        file: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"my_page.js"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,     </span><span style="--shiki-dark:#8B949E;--shiki-light:#6E7781">// Output alongside the page definition</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        format: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"umd"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        name: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"MyPage"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        inlineDynamicImports: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">true</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    }</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">,</span>
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">    </span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">plugins: [</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">nodeResolve</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">({ browser: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">true</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> })]</span><span style="--shiki-dark:#FFA657;--shiki-light:#953800">,</span>
<span style="--shiki-dark:#FFA657;--shiki-light:#953800">}</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">;</span>
```

### Development with Live Reload

Both Vite and Rollup can publish to Frappe's Redis event bus for live reload:

```
<span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">async</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">function</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">notifyFrappeReload</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">() {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">const</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> { </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">createClient</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> } </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">require</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"@redis/client"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">);</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">const</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">client</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">=</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">createClient</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">({</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        url: process.env.</span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">FRAPPE_REDIS_QUEUE</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">||</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"redis://queue:6379"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    });</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">await</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> client.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">connect</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">();</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">await</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> client.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">publish</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">(</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"events"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">, </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">JSON</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">stringify</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">({</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        event: </span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"build_event"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        message: {</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            success: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">true</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            changed_files: [</span><span style="--shiki-dark:#A5D6FF;--shiki-light:#0A3069">"my_page.js"</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">],</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">            live_reload: </span><span style="--shiki-dark:#79C0FF;--shiki-light:#0550AE">true</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">,</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">        },</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    }));</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">    </span><span style="--shiki-dark:#FF7B72;--shiki-light:#CF222E">await</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328"> client.</span><span style="--shiki-dark:#D2A8FF;--shiki-light:#8250DF">disconnect</span><span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">();</span>
<span style="--shiki-dark:#E6EDF3;--shiki-light:#1F2328">}</span>
```

See [Vite & TypeScript Compilation](/kb/frappe/vite-typescript-compilation/) for the full Vite-based build setup.

## Frappe Page API

Useful methods on the `page` object returned by `frappe.ui.make_app_page`:

| Method                                    | Purpose                             |
| ----------------------------------------- | ----------------------------------- |
| `page.main`                               | jQuery wrapper for the content area |
| `page.set_title(title)`                   | Update page title                   |
| `page.set_primary_action(label, fn)`      | Primary action button               |
| `page.set_secondary_action(label, fn)`    | Secondary action button             |
| `page.add_menu_item(label, fn)`           | Add to the "..." menu               |
| `page.add_inner_button(label, fn, group)` | Grouped inner buttons               |
| `page.clear_primary_action()`             | Remove primary button               |

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/)

[← PreviousCustom Field Controllers](/kb/frappe/custom-field-controllers/)[Next →Custom Views](/kb/frappe/custom-views/)

CC0This article 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

- [Page Setup](#page-setup)
- [Page DocType Definition](#page-doctype-definition)
- [Page JSON](#page-json)
- [Empty Python File](#empty-python-file)
- [Mounting the Application](#mounting-the-application)
- [Entry Point Pattern](#entry-point-pattern)
- [With Vue](#with-vue)
- [With Declarative DOM](#with-declarative-dom)
- [Frappe Realtime Integration](#frappe-realtime-integration)
- [Server-Side API Endpoints](#server-side-api-endpoints)
- [External SQL Files](#external-sql-files)
- [Build Pipeline](#build-pipeline)
- [Rollup (Simple, No Vue SFCs)](#rollup-simple-no-vue-sfcs)
- [Development with Live Reload](#development-with-live-reload)
- [Frappe Page API](#frappe-page-api)

[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/)
