https://github.com/fireflyframework/fireflyframework-utils
Shared utility library with template rendering, filtering annotations, and common helper functions used across framework modules.
https://github.com/fireflyframework/fireflyframework-utils
Last synced: 3 months ago
JSON representation
Shared utility library with template rendering, filtering annotations, and common helper functions used across framework modules.
- Host: GitHub
- URL: https://github.com/fireflyframework/fireflyframework-utils
- Owner: fireflyframework
- License: apache-2.0
- Created: 2026-02-06T12:34:03.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-02-18T12:14:46.000Z (4 months ago)
- Last Synced: 2026-02-18T15:54:40.777Z (4 months ago)
- Language: Java
- Size: 87.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Firefly Framework - Utilities
[](https://github.com/fireflyframework/fireflyframework-utils/actions/workflows/ci.yml)
[](LICENSE)
[](https://openjdk.org)
[](https://spring.io/projects/spring-boot)
> Utility library providing template rendering, PDF generation, and filtering annotations for Firefly Framework applications.
---
## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Configuration](#configuration)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)
## Overview
Firefly Framework Utilities provides a set of common utility classes used across the framework ecosystem. It includes template rendering powered by FreeMarker, PDF generation via Flying Saucer with OpenPDF, and filtering annotations for domain entity identification.
This library is a lightweight foundation module with minimal dependencies, designed to be included wherever utility functions are needed without pulling in the full framework stack.
## Features
- Template rendering with FreeMarker via `TemplateRenderUtil`
- PDF generation using Flying Saucer and OpenPDF
- `@FilterableId` annotation for marking domain entity identifiers
- Lightweight with minimal transitive dependencies
## Requirements
- Java 21+
- Spring Boot 3.x
- Maven 3.9+
## Installation
```xml
org.fireflyframework
fireflyframework-utils
26.02.06
```
## Quick Start
```java
import org.fireflyframework.utils.template.TemplateRenderUtil;
// Render a FreeMarker template
Map data = Map.of("name", "Firefly");
String result = TemplateRenderUtil.render("hello.ftl", data);
```
## Configuration
No configuration is required. This library provides standalone utility classes.
## Documentation
No additional documentation available for this project.
## Contributing
Contributions are welcome. Please read the [CONTRIBUTING.md](CONTRIBUTING.md) guide for details on our code of conduct, development process, and how to submit pull requests.
## License
Copyright 2024-2026 Firefly Software Solutions Inc.
Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for details.