How quillforms/quillforms works
Project Type & Purpose
• Quill Forms is an open-source, self-hosted “Typeform alternative” implemented as a WordPress plugin plus a standalone React/TypeScript library (monorepo managed by Lerna).
• It provides a drag-and-drop form builder (admin UI in React) and a dynamic form renderer (client-side React) that communicates with a PHP-based backend via WP REST API.
High-Level Components
A. Docker & DevOps
• docker-compose.yml orchestrates two containers:
– PHP/WordPress container (runs MySQL, Apache/Nginx, WordPress + QuillForms plugin)
– Node container (for local builds, Lerna, webpack, Babel, TypeScript)
• Build scripts (packages/scripts folder) invoked inside the Node container.
B. WordPress + PHP Backend
• quillforms.php: Plugin bootstrap that registers hooks.
• includes/: Core PHP classes – plugin loader, REST controllers (includes/rest-api), data models, entry processing, payment gateways, compatibility adapters, installers, logger, import/export.
• composer.json / vendor/: PHP dependencies autoloaded.
• DB: Uses WordPress’s MySQL database to store forms, entries, settings, logs, coupons, etc.
C. Frontend React Admin UI (client/)
• client/index.js: Entry point for the React SPA loaded in WP admin.
• client/components & pages/: Form builder UI—blocks panel, sidebar, pages for settings, integrations, payments, results, system.
• CSS/SCSS assets extracted via Webpack and mini-CSS-extract-plugin.
• Communicates to PHP backend via WP REST API endpoints (e.g., /wp-json/quillforms/v1/…).
D. Monorepo Packages (packages/)
• builder-core, builder-panels, block-editor, admin-components, code-editor, document-editor, form-integrations, payment-gateways, renderer-core, react-renderer-utils, rest-fields, settings-editor, theme-editor, types, utils, etc.
• Each is a self-contained npm package (TypeScript or JavaScript) used to build aspects of the UI and renderer.
• Lerna manages inter-package dependencies, versioning, and bootstrapping.
E. Client-Side Renderer
• Built from renderer-core + react-renderer-utils + rest-fields: Generates the public-facing form embed (via iframe or inline) on WP front-end or any React/Next.js app.
• Exposes React Hooks and components for embedding in external React applications (Next.js support).
Data Flows & Interactions
1. Admin loads WP → plugin enqueues React admin bundle.
2. React admin UI performs CRUD via REST API: fetch form definitions, save settings, manage payments, view entries.
3. PHP REST controllers handle requests, validate, read/write to MySQL via WP APIs.
4. For public forms, WP shortcode or iframe embed loads the JS renderer bundle (standalone React) → fetch form schema via REST → render and submit entries back to PHP.
5. Payments flow: renderer triggers external payment gateway (Stripe, PayPal, etc.) via client-side SDK or redirects → upon success, PHP records transaction.
6. Docker/Node build pipeline watches packages, compiles TS → outputs to lib/ and client/assets → PHP enqueues those.
Architectural Patterns & Design Principles
• Monorepo with Lerna: modular packages sharing types and utilities
• Plugin architecture (WordPress hooks/filters + REST controllers)
• Component-based UI (React + Context/Redux-style stores)
• Separation of concerns: Admin UI vs. Renderer vs. Back-end
• API-driven: All state persists via REST endpoints, enabling headless use
• Build pipeline decoupled via Docker: isolation of PHP and Node environments
Detail Level
• Drill into PHP layer: show REST controllers, model classes, plugin hooks.
• Drill into React layer: show store/context providers, main pages (builder, results, settings).
• Don’t overcrowd; group similar packages under “Monorepo Packages” cluster but call out major ones (builder-core, renderer-core, form-integrations).