DGNum/Stirling-PDF
14
0
Fork 0
Code Issues 4 Pull requests 1 Projects Releases Packages Wiki Activity

README.md(#13)

Browse source 
* Update README.md

* Update README.md
This commit is contained in:
Anthony Stirling 2023-01-30 21:27:17 +00:00 committed by GitHub
parent 9d89621cfd
commit aa79741e8e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -20,6 +20,7 @@ I will support and fix/add things to this if there is a demand [Discord](https:/
## Technologies used ## Technologies used
- Spring Boot + Thymeleaf - Spring Boot + Thymeleaf
- PDFBox - PDFBox
- e-iceblue spire.pdf.free (for PDF compression untill i find a nicer way)
- HTML, CSS, JavaScript - HTML, CSS, JavaScript
- Docker - Docker
@ -29,20 +30,29 @@ I will support and fix/add things to this if there is a demand [Discord](https:/
Prerequisites Prerequisites
- Java 17 or later - Java 17 or later
- Gradle 6.0 or later - Gradle 7.0 or later
1. Clone or download the repository. 1. Clone or download the repository.
2. Build the project using Gradle by running `./gradlew build` 2. Build the project using Gradle by running `./gradlew build`
3. Start the application by running `./gradlew bootRun` 3. Start the application by running `./gradlew bootRun` or by calling the build jar in build/libs with java -jar jarName.jar
### Docker ### Docker
https://hub.docker.com/r/frooodle/s-pdf https://hub.docker.com/r/frooodle/s-pdf
docker pull frooodle/s-pdf Docker Run
```
docker run -p 8080:8080 frooodle/s-pdf docker run -p 8080:8080 frooodle/s-pdf
```
Docker Compose
```
version: '3.3'
services:
s-pdf:
ports:
- '8080:8080'
image: frooodle/s-pdf
```
## How to View ## How to View
1. Open a web browser and navigate to `http://localhost:8080/` 1. Open a web browser and navigate to `http://localhost:8080/`