Installation Guide

Prerequisites

• Magnolia DXP 6.3 or higher
• Java 17 or higher
• Maven 3.6 or higher

1. Add Maven Dependency

Add the following dependency to your Magnolia bundle's pom.xml:

<dependency>
    <groupId>work.noice</groupId>
    <artifactId>easyforms</artifactId>
    <version>1.1</version>
</dependency>

2. Start Magnolia

Start (or restart) Magnolia. The module will be automatically installed and registered. You can then access the Forms app from the Magnolia AdminCentral app launcher.

3. Creating Your First Form

1. Open the Forms app in Magnolia AdminCentral
2. Click Add form
3. Give your form a name and select the "Form" template
4. Configure form properties:
   • Form Identifier: Unique ID for the form
   • Submission Type: Choose "Submit via URL/API" or "Send via Email"
   • Success/Error Messages: Customize user feedback
5. Add form components using the familiar Magnolia page editor interface

Available Form Components

• Text Inputs: Text, email, telephone, number, date, password
• Choice Fields: Checkboxes, radio buttons, dropdowns, multi-select
• Layout Components: Rows for responsive multi-column layouts
• Conditional Logic: Show/hide fields based on user input
• Hidden Fields: Include data that users don't see
• Buttons: Customizable submit and action buttons

4. Email Configuration (Optional)

To send form submissions via email, configure your form properties:

• Fixed Email: Always send to the same address
• Dynamic Email: Route to different addresses based on form field values (e.g., department selection)

Ensure your Magnolia instance has SMTP configured for email delivery.

5. Spam Protection (Optional)

Easy Forms includes reCAPTCHA v3 integration. To enable:

1. Obtain reCAPTCHA v3 site and secret keys from Google reCAPTCHA Admin
2. Configure the keys in your form settings
3. reCAPTCHA will invisibly protect your forms from bots

Building from Source

git clone https://github.com/noicework/easyforms.git
cd easyforms
mvn clean install