Skip to content

Roudolph1010/docflow-report-builder

Repository files navigation

DocFlow Report Builder

A form-driven report builder with structured section entry, equipment reference data, live summary, and .docx export — built with Next.js and TypeScript.


Screenshots

Step 1 — Report Details Report Details

Step 3 — Fill Sections with Equipment Autofill Fill Sections

Step 4 — Summary & Export Summary and Export

Exported .docx Output Exported Document


What This Is

DocFlow Report Builder lets users build structured inspection reports through a guided step-by-step flow. Users select which sections to include, fill in typed fields, pick equipment from a reference list, review a live summary, and download a formatted .docx file — all in the browser with no backend required.


Stack

Technology Version
Next.js 16 (App Router)
React 19
TypeScript 5
Tailwind CSS 4
docx 9

No database. No authentication. All data is in-memory.


Features

  • Report setup — Enter title, project name, client name, and date
  • Section selection — Choose which sections to include: Visual Inspection, Distribution Test, Seal Check
  • Structured forms — Text, number, select, checkbox, textarea, and read-only boilerplate fields per section
  • Conditional fields — Extra fields appear based on selected values (e.g. review notes when result is "Needs Review")
  • Equipment autofill — Select from a reference equipment list to auto-populate instrument details
  • Live summary table — Updates in real time as sections are filled in
  • .docx export — Downloads a fully structured Word document with all field values, equipment info, boilerplate text, and a summary table

Run Locally

git clone <repo-url>
cd docflow-report-builder
npm install
npm run dev

Open http://localhost:3000 in your browser.


Deploy to Vercel

This project deploys to Vercel with no configuration required.

  1. Push to a GitHub repository
  2. Import the repo at vercel.com/new
  3. Click Deploy — no environment variables needed

Project Structure

app/
  layout.tsx          # Root layout with header and footer
  page.tsx            # Home page
  builder/
    page.tsx          # Report builder — step-by-step flow

components/
  ReportMetaForm.tsx  # Title, project, client, date fields
  SectionSelector.tsx # Section selection checkboxes
  SectionForm.tsx     # Dynamic form per section with conditional fields
  EquipmentSelect.tsx # Equipment dropdown with autofill
  SummaryTable.tsx    # Live summary table
  ExportButton.tsx    # .docx generation and download

lib/
  types.ts            # TypeScript interfaces
  buildDocument.ts    # docx assembly logic

data/
  sections.ts         # Section definitions with field schemas
  equipment.ts        # Reference equipment list

Out of Scope

  • Authentication and user management
  • Database or persistent storage
  • Multi-report dashboard
  • PDF export
  • Approval workflows
  • Audit history

About

Form-driven report builder with section selection, equipment autofill, live summary, and .docx export - built with Next.js and TypeScript.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors