Install & Setup

This page walks you, the organizer or site admin, through installing Buzz on a Frappe bench, what the install seeds for you, and how the attendee/organizer dashboard is built and served. Once Buzz is on your site you can move on to Create an Event.

If you are new to Buzz, read What is Buzz first for the big picture.

Before you begin

You need a working Frappe bench with a site. Buzz targets:

Frappe >=16.0.0,<18.0.0
Python >=3.10

Buzz also has a required app dependency on frappe/payments — it is declared in Buzz's hooks, so bench will refuse to install Buzz unless payments is present on the bench. Get both apps first:

# from your bench directory
bench get-app payments
bench get-app https://github.com/BuildWithHussain/buzz

Install Buzz on a site

Install the payments app first (it is a hard requirement), then Buzz:

bench --site your-site.localhost install-app payments
bench --site your-site.localhost install-app buzz

Buzz's install hook runs automatically and seeds the data described below. After installing, open Desk and you should see the Buzz app on the apps screen.

What the install seeds

The after_install hook (buzz/install.py) does two things:

Default Event Categories

Four Event Category records are created, each with its own icon, so you can publish an event without first defining categories:

Meetups
Conferences
Local
Webinars

You can edit, disable, or add categories later — see Venue, Category & Host.

Custom fields for optional integrations

The installer registers integration custom fields, but only for apps that are actually present on the bench. If you install one of the optional apps after Buzz, the matching fields are added automatically (and removed again on uninstall):

crm — adds a Buzz tab to CRM Lead (Buzz Campaign + Event Ticket links).
zoom_integration — adds Zoom fields to Buzz Event, Buzz Settings, and Event Ticket (see Webinars below).

These same fields are re-applied on every bench migrate via the migrate hook, so they self-heal.

Roles created on install

Buzz ships two roles as fixtures:

Buzz User — the baseline role for anyone interacting with the dashboard. It is assigned automatically to every new User (via the User after_insert hook), so attendees, speakers, and sponsors get it without manual setup.
Frontdesk Manager — gates the check-in scanner. Assign this role to door staff who need to scan tickets. See Check-in Scanner.

For who-can-do-what, see Roles & Permissions.

Optional: Zoom integration for webinars

If you run webinar-style events, install buildwithhussain/zoom_integration. With it present, Buzz lets you link a Zoom Webinar to a Buzz Event, set a Default Webinar Template in Buzz Settings, and track a Zoom Webinar Registration per ticket. The custom fields wiring this up is added the moment the app is installed:

bench get-app https://github.com/BuildWithHussain/zoom_integration
bench --site your-site.localhost install-app zoom_integration

Webinar support is entirely optional — Buzz works fully without it.

The dashboard: build & serve

The attendee/organizer experience is a Vue 3 + frappe-ui single-page app under dashboard/. It is served under the /b/... base route (for example /b/account/bookings, /b/check-in, /b/<event-route>/register).

Older /dashboard/* links (including /dashboard/book-tickets/*) are kept alive by redirects to the /b/* scheme, so existing links keep working. Throughout this guide we use /b/....

Production build

Build the dashboard to ship it. The Vite build (dashboard/vite.config.js) outputs the compiled assets to buzz/public/dashboard and writes the entry HTML to buzz/www/dashboard.html, which Frappe serves at the /b route:

yarn build
# equivalent to: cd dashboard && yarn build

Local development

For active frontend work, run the dev server, which proxies API calls to your bench on port 8080:

yarn dev
# or: cd dashboard && yarn dev

Use the dev server URL (port 8080) for frontend changes; use the built dashboard at /b/... for everything else.

Verify the install

A few quick checks:

# confirm Buzz (and payments) are installed on the site
bench --site your-site.localhost list-apps

Then open Desk at /app, confirm the Buzz app appears, and open the Event Category list to see the four seeded categories. You are ready to create your first event.