How nozomi-75/gomis works
Project Type and Purpose
• GOMIS is a full-stack desktop application (JavaFX) that manages guidance-office workflows (student records, incidents, appointments, certificates) and connects to a MariaDB database.
• It also includes a small standalone “gomis-account-validator” utility and a multi-stage packaging/installer component (“gomis-installer”) that bundles the JRE, wraps the app into an .exe (via Launch4j), and builds an Inno Setup installer.
High-Level Components
a. UI Layer (JavaFX)
• Packages: lyfjshs.gomis.view (panels, forms), lyfjshs.gomis.components (custom controls, charts, notifications, tables, form manager)
b. Business Logic / Services
• Core application logic often lives in utils (EventBus, ValidationUtils, SystemOutCapture), FormManager, AlarmManagement, SettingsManager
c. Data Access Layer (DAO)
• lyfjshs.gomis.Database.DAO: DAOs for Users, Students, Incidents, Appointments, etc.
• DBConnection: JDBC connection wrapper, error handling
d. Database
• MariaDB instance (schema created by gomisDB.sql)
• Entities under Database.entity map to tables
e. Document Generation Module
• docPrinter package: generators for dropping forms, good moral certificates, incident reports; template manager; uses docx4j
f. Utility Validator
• gomis-account-validator: small Java Maven project producing a JAR that validates account credentials (used in installer step)
g. Packaging & Installer
• gomis-installer: PowerShell build script (build-all.ps1)
• Launch4j: wraps the main JAR into a Windows .exe, bundles libraries
• Bundled JRE folder under resources/jre
• Inno Setup scripts (.iss) to build the Windows installer, execute SQL, configure MariaDB
Relationships & Data Flow
• UI Layer → Business Logic → DAO Layer → MariaDB
(arrowed flows for read/write)
• UI Layer → Document Generation Module → “Print” (DOCX/PDF)
• build-all.ps1 (PowerShell) orchestrates → Maven build of main app & validator → Launch4j wrap → JRE copy → Inno Setup compile → Installer.exe
• Installer.exe on client machine → Deploys JRE + App.exe + Validator.jar → Runs database setup scripts → User launches .exe → app connects to local MariaDB
Architectural Patterns / Principles
• MVC-style separation: view (JavaFX), controllers/services (utils, event bus), data layer (DAO + entities)
• Layered architecture: Presentation → Service/Business → Persistence → Database
• Plugin-style doc generators: docPrinter modules implement a common interface for different form types
• Build/packaging pipeline as a separate concern (scripts + external tools)
Technologies & Frameworks
• Java 17+, JavaFX for UI
• Apache Maven for dependency management/build
• MariaDB (JDBC) for persistence
• docx4j for document generation
• Launch4j for EXE wrapping
• Inno Setup for installer
• PowerShell & batch scripts to orchestrate build and database setup
Must-Include
• Clear component names (e.g., “MainDashboard (JavaFX)”, “AppointmentDAO”, “MariaDB gomisdb”)
• A note on the build-installer pipeline separate from runtime