README.md

Blazor Form Builder

Blazor Form Builder is a comprehensive library for generating and managing forms within Blazor applications. It provides a simple interface for creating forms with various field types, including text, numeric, date, and dropdown fields. The library includes a Blazor WebAssembly application for designing and rendering forms from a JSON schema.

Features

• Dynamic Form Creation: Easily create forms with text, numeric, date, and dropdown fields.
• Form Designer: A Blazor WebAssembly application for visually designing forms.
• Form Renderer: Render forms based on a JSON schema.
• Integration: Seamlessly integrates with a Web API for form data management.

Demo

• Form Designer: Try out the demo form builder available here on GitHub Pages.

Getting Started

Follow these steps to set up and run the Blazor Form Builder:

Prerequisites

• .NET 8.0 SDK
• SQL Server

Setup Instructions

1. Clone the Repository

   Clone this repository using the following command:

   git clone https://github.com/suxrobGM/blazor-form-builder.git
   cd blazor-form-builder

2. Configure the Database

   Update the connection string in the appsettings.json file located at src/FormBuilder.API/appsettings.json to match your SQL Server database configuration.

3. Apply Database Migrations

   Apply the database migrations by running the following command script:

   scripts/apply-migrations.cmd

4. Run the Web API Project

   Start the Web API project by running the following command script:

   scripts/run-api.cmd

5. Run the Blazor Application

   Start the Blazor WebAssembly application by running the following command script:

   scripts/run-app.cmd

Accessing the Applications

Once the projects are running, you can access them via the following URLs:

• Web API: https://localhost:8000/swagger/index.html
• Blazor WASM App: https://localhost:8001

Project Structure

• FormBuilder: The Razor class library containing reusable Blazor components, services, and models for form creation and rendering.
• FormBuilder.API: The Web API project for managing form data and LOV (List of Values) data.
• FormBuilder.DesignerApp: The Blazor WebAssembly project for designing and rendering forms.
• FormBuilder.Shared: The shared project containing common models used across the FormBuilder and FormBuilder.API projects.

Documentation

• API Reference: Learn how to use the Form Builder API to create, update, delete, and retrieve forms and LOV data.
• Integration Guide: Integrate the Blazor Form Builder with your existing Blazor application.
• Form Editor Component Reference: Design forms in your Blazor application using the FormEditor component.
• Form Renderer Component Reference: Render forms in your Blazor application using the FormRenderer component.

Screenshots