Skip to content
BASIL LAL edited this page May 30, 2026 · 1 revision

Cardify Wiki

Overview

Cardify is a JavaFX desktop app that converts an HTML template + Excel data into printable cards.


Features

  • Template-based card generation
  • Image & QR support
  • Excel import/export
  • Preview & print

Quick Start

Prerequisites

  • Java 11+
  • Maven
  • JavaFX setup

Run

mvn clean install

Steps

  1. Open app → Template tab
  2. Upload HTML template ({{placeholders}})
  3. Download Excel template
  4. Fill data (1 row = 1 card)
  5. Upload Excel
  6. Preview → Print

Screenshots

  • Data Section
Screenshot from 2026-05-30 14-36-42 * Template and excel section Screenshot from 2026-05-30 14-36-54 * "How to use" Section Screenshot from 2026-05-30 14-37-01 * Dark Mode Screenshot from 2026-05-30 14-37-16

Usage

Template Tab

  • Upload HTML template
  • Download Excel template
  • Save templates

Data Tab

  • Upload Excel
  • View & filter rows
  • Select rows

Preview & Print

  • Template Preview
  • Row Preview
  • Print Selected Rows

Template Reference

Placeholders

{{name}}
{{photo}}

Images

<img src="{{photo}}">

QR Fields

Use names like:

qr_code
employee_qr

Tips

  • Use fixed CSS sizes
  • Test preview before printing
  • Prefer local image paths

Excel Format

| name | department | photo | qr_code |

Rules

  • Text → normal values
  • Image → file path
  • QR → text

Architecture

Flow

UI → Controller → Services → Utilities

Components

  • MainApp.java → entry
  • MainController.java → UI
  • Services → template, excel, print
  • Model → SpreadsheetRow

Data Flow

Template → Excel → Parse → Render → Preview/Print


Developer Guide

Structure

controller/
service/
model/
util/

Setup

  • Import as Maven project
  • Configure JavaFX

Guidelines

  • Keep services separate
  • Avoid UI logic in services
  • Add unit tests

Services

HtmlTemplateService

  • Detect placeholders
  • Render HTML
  • Handle images & QR

ExcelImportService

  • Create template
  • Read Excel

ExcelExportService

  • Export data

PrinterService

  • Print cards

Troubleshooting

Issues

  • Images not showing → check file path
  • QR not working → use qr_ in name
  • Layout issues → fix CSS size

Tips

  • Re-upload template
  • Use preview before print

Contributing

  • Fork repo
  • Create branch
  • Submit PR

Checklist

  • Tests added
  • Build passes
  • Docs updated

Changelog

  • v0.1.0 → Initial release
  • v0.1.1 → QR & image improvements

License

Add your license here (MIT / etc.)


Assets

Add:

  • Screenshots (UI, preview)
  • Sample HTML template
  • Sample Excel files