ukase
Ukase is renderer for html
, pdf
and simple xlsx
files written as service with Java 8.
Releases provided as self-runnable war
that bundled with Spring Boot.
Get&configure
Get
There are two ways:
- Download release from GitHub (ukase-x.x.x.war file)
- Extend/get/repack with maven build system:
<dependency>
<groupId>com.github.ukase</groupId>
<artifactId>ukase</artifactId>
<version>LATEST</version>
</dependency>
- Download release using maven shell command (buggy method to get - work well only if you have copy in local repo, otherwise problems are possible):
mvn dependency:get -Dartifact=com.github.ukase:ukase:LATEST:war -Dtransitive=false -Ddest=ukase.jar
Configure
- Create directory for this application
- Move there downloaded
war
file - Create
config
subfolder - Create
application.yml
file there:
Start
You can start application:
- in your web application container (like tomcat or jetty)
- using included SpringBoot runner:
java -jar name_of_saved_war.war
Usage
We propogate next usage templates:
- prod
- using by some subsystem of other application to generate pdf-s over UKase API
- development
- using by development environment of any application to generate pdf-s over UKase API
- using by developer to create and modify pdf templates. For these case we have UI that enables view and view's auto-refresh on any template change.
Xlsx rendering feature
UKase API
Short list (more):
- POST /api/html
- POST /api/pdf
- GET /api/pdf/{templateName}
- POST /api/bulk/sync
- POST /api/xlsx Async API
- POST /api/async/xlsx
- POST /api/async/pdf/bulk
- GET /api/async/{id}/status
- GET /api/async/{id}
License 📜
Ukase is available over GNU Affero General Public License (see more information here);