An open API service indexing awesome lists of open source software.

https://github.com/idrsolutions/buildvu-microservice-example

BuildVu Microservice Example
https://github.com/idrsolutions/buildvu-microservice-example

application buildvu example html idrsolutions microservice pdf server web

Last synced: about 1 month ago
JSON representation

BuildVu Microservice Example

Awesome Lists containing this project

README

          

# BuildVu Microservice Example #

IDRsolutions' BuildVu Microservice Example is an open source project that allows you to convert PDF to HTML5 or SVG by running BuildVu as a web service in the cloud or on-premise.

**Please note that BuildVu is paid-for, commercial software - however you can use the trial version for free. Just rename the trial .jar to "buildvu.jar".**

-----

# How do I get set up? #

### What you'll need: ###

* [BuildVu](https://www.idrsolutions.com/buildvu/download/) - this provides all the conversion functionality.
* [Maven](https://maven.apache.org/download.cgi) - used to build the .war file.

### Trial Version: ###

If you do not have a full verison of BuildVu you can get the trial version from [here](https://www.idrsolutions.com/buildvu/trial-download/).

### Build: ###

Clone a copy of the buildvu-microservice-example git repo:

```
git clone git://github.com/idrsolutions/buildvu-microservice-example
```

Add the BuildVu jar to the project by copying it into the /lib directory. Make sure that it is named "buildvu.jar"

Open up a terminal / command prompt window in the base directory of the buildvu-microservice-example project, and build the .war file by running the command:
```
mvn compile war:war
```

This will generate the buildvu.war file inside the /target directory.

### Deployment: ###

See our [application server tutorials](https://docs.idrsolutions.com/buildvu/app-server-deployment/) for instructions on deployment.

See our [cloud platform tutorials](https://docs.idrsolutions.com/buildvu/docker-deployment/) for instructions on cloud deployment.

### docker-compose deployment: ###

Docker usage has moved to it's own project [here](https://github.com/idrsolutions/buildvu-docker).

-----

### Usage: ###

You can interact with the BuildVu Microservice Example using the REST API.

A complete list of raw requests that can be used can be found [here](/API.md).

For specific languages, see our tutorials on how to [run BuildVu from other languages](https://docs.idrsolutions.com/buildvu/languages/).

-----

# Who do I talk to? #

Found a bug, or have a suggestion / improvement? Let us know through the Issues page.

Got questions? You can contact us [here](https://idrsolutions.my.site.com/s/request).

-----

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.