# jodconverter-samples

**Repository Path**: juht/jodconverter-samples

## Basic Information

- **Project Name**: jodconverter-samples
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-11-14
- **Last Updated**: 2024-11-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# <img src="https://github.com/jodconverter/jodconverter/wiki/images/jodconverter_w200.png">&nbsp;<sup>&nbsp;LibreOffice</sup>&nbsp;/&nbsp;<sub>Apache OpenOffice</sub>

JODConverter Samples
====================

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Welcome! Here you will find sample projects using [JODConverter](https://github.com/jodconverter/jodconverter).

The projects in this directory demonstrate typical use cases using the JODConverter project. They include:

- [`samples/basic-webapp`](./samples//basic-webapp): Demonstrates how to use the [jodconverter-local-lo](https://github.com/jodconverter/jodconverter/tree/master/jodconverter-local-lo) module to build a basic web application.
- [`samples/spring-boot-rest`](./samples//spring-boot-rest): Demonstrates how to use the [jodconverter-spring-boot-starter](https://github.com/jodconverter/jodconverter/tree/master/jodconverter-spring-boot-starter) module to build a REST API supporting document conversions.
- [`samples/spring-boot-webapp`](./samples//spring-boot-webapp): Demonstrates how to use the [jodconverter-spring-boot-starter](https://github.com/jodconverter/jodconverter/tree/master/jodconverter-spring-boot-starter) module to build a web application with thymeleaf and bootstrap.

## Build and run

See the subprojects. In short

```bash
# run webapp
./gradlew :samples:spring-boot-webapp:bootRun
# build rest-app
./gradlew :samples:spring-boot-rest:bootRun
```

You can access the apps via `http://localhost:8080`


### Docker based

If you do not have a local java SDK or just prefer docker, use

```
# run webapp
docker run --rm -p 8080:8080 ghcr.io/jodconverter/jodconverter-examples:gui

# unr rest-only app
docker run --rm -p 8080:8080 ghcr.io/jodconverter/jodconverter-examples:rest
```

You can access the apps via `http://localhost:8080`

The docker images are build in [jodconverter/docker-image-jodconverter-examples](https://github.com/jodconverter/docker-image-jodconverter-examples). Use them as a starting point for an application, if you like.