Skip to content

Commit 82949c8

Browse files
Added readme and license files for Ktor sample
1 parent 68c3f01 commit 82949c8

7 files changed

Lines changed: 161 additions & 13 deletions

File tree

Demos/Compose/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,9 @@ Please have a look at the LICENSE.md for more details
8383

8484
## GroupDocs Comparison on other platforms & frameworks
8585

86-
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java-Spring) with JAVA Spring
87-
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java-Dropwizard) with JAVA Dropwizard
86+
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Spring) with JAVA Spring
87+
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Dropwizard) with JAVA Dropwizard
88+
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Ktor) with JAVA Ktor
8889
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-.NET-MVC) with .NET MVC
8990
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-.NET-WebForms) with .NET WebForms
9091

Demos/Dropwizard/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ New GroupDocs.Comparison for Java Dropwizard UI Example
55

66
[![Build Status](https://travis-ci.org/groupdocs-comparison/GroupDocs.Comparison-for-Java-Dropwizard.svg?branch=master)](https://travis-ci.org/groupdocs-comparison/GroupDocs.Comparison-for-Java-Dropwizard)
77
[![Maintainability](https://api.codeclimate.com/v1/badges/bd15712ebdd04405b1ea/maintainability)](https://codeclimate.com/github/groupdocs-comparison/GroupDocs.Comparison-for-Java-Dropwizard/maintainability)
8-
[![GitHub license](https://img.shields.io/github/license/groupdocs-comparison/GroupDocs.Comparison-for-Java-Dropwizard.svg)](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java-Dropwizard/blob/master/LICENSE)
8+
[![GitHub license](https://img.shields.io/github/license/groupdocs-comparison/GroupDocs.Comparison-for-Java-Dropwizard.svg)](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Dropwizard/blob/master/LICENSE)
99

1010
## System Requirements
1111
- Java 8+ (JDK 1.8+)
@@ -58,7 +58,7 @@ You can run this sample by one of following methods
5858

5959
#### Build from source
6060

61-
Download [source code](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java-Dropwizard/archive/master.zip) from GitHub or clone this repository.
61+
Download [source code](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/archive/refs/heads/master.zip) from GitHub or clone this repository.
6262

6363
```bash
6464
git clone https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java.git
@@ -74,7 +74,7 @@ Download [latest release](https://github.com/groupdocs-comparison/GroupDocs.Comp
7474
**Note**: This method is **recommended** for running this sample behind firewall.
7575

7676
```bash
77-
curl -J -L -o release.tar.gz https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java-Dropwizard/releases/download/1.8.17/release.tar.gz
77+
curl -J -L -o release.tar.gz https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/releases/download/v22.3/groupdocs-comparison-dropwizard-22.3.0.tar.gz
7878
tar -xvzf release.tar.gz
7979
cd release
8080
java -jar comparison-1.8.6.jar configuration.yaml
@@ -142,8 +142,9 @@ Please have a look at the LICENSE.md for more details
142142

143143
## GroupDocs Comparison on other platforms & frameworks
144144

145-
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java-Spring) with JAVA Spring
145+
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Spring) with JAVA Spring
146146
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Compose) with Kotlin in Compose Desktop application
147+
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Ktor) with JAVA Ktor
147148
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-.NET-MVC) with .NET MVC
148149
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-.NET-WebForms) with .NET WebForms
149150

Demos/Ktor/LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 GroupDocs.Comparison Product Family
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Demos/Ktor/README.md

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
![GroupDocs.Comparison](https://raw.githubusercontent.com/groupdocs-comparison/groupdocs-comparison.github.io/master/resources/image/banner.png "GroupDocs.Comparison")
2+
# GroupDocs.Comparison for Java Ktor Example
3+
New GroupDocs.Comparison for Java Ktor UI Example
4+
###### version 22.3
5+
6+
[![GitHub license](https://img.shields.io/github/license/groupdocs-comparison/GroupDocs.Comparison-for-Java-Spring.svg)](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java-Spring/blob/master/LICENSE)
7+
8+
## System Requirements
9+
- Java 11+ (JDK 11+)
10+
11+
12+
## Compare documents with Java API
13+
14+
**GroupDocs.Comparison for Java** is a library that allows you to **compare PDF, DOCX, PPT, XLS,** and over 90 other document formats. With GroupDocs.Comparison for Java you will be able to compare two or more files, perform style and text comparison and generate a detailed report with changes.
15+
16+
This application allows you to compare multiple documents and can be used as a standalone application or integrated as part of your project.
17+
18+
**Note:** without a license application will run in trial mode, purchase [GroupDocs.Comparison for Java license](https://purchase.groupdocs.com/order-online-step-1-of-8.aspx) or request [GroupDocs.Comparison for Java temporary license](https://purchase.groupdocs.com/temporary-license).
19+
20+
21+
## Demo Video
22+
23+
<p align="center">
24+
<a title="Document comparison for JAVA " href="https://www.youtube.com/watch?v=82RuvtV2qpw">
25+
<img src="https://raw.githubusercontent.com/groupdocs-comparison/groupdocs-comparison.github.io/master/resources/image/comparison.gif" width="100%" style="width:100%;">
26+
</a>
27+
</p>
28+
29+
30+
## Features
31+
#### GroupDocs.Comparison
32+
- Clean, modern and intuitive design
33+
- Easily switchable colour theme (create your own colour theme in 5 minutes)
34+
- Responsive design
35+
- Mobile support (open application on any mobile device)
36+
- HTML and image modes
37+
- Fully customizable navigation panel
38+
- Compare documents
39+
- Multi-compare several documents
40+
- Compare password protected documents
41+
- Upload documents
42+
- Display clearly visible differences
43+
- Download comparison results
44+
- Print comparison results
45+
- Smooth document scrolling
46+
- Preload pages for faster document rendering
47+
- Multi-language support for displaying errors
48+
- Cross-browser support (Safari, Chrome, Opera, Firefox)
49+
- Cross-platform support (Windows, Linux, MacOS)
50+
51+
52+
## How to run
53+
54+
You can run this sample by one of following methods
55+
56+
57+
#### Run using IDE
58+
59+
Download [source code](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java-Spring/archive/master.zip) from github or clone this repository.
60+
61+
```bash
62+
git clone https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java.git
63+
cd GroupDocs.Comparison-for-Java/Demos/Ktor
64+
```
65+
Open project in IDE. Open `Application.kt` file and run `main` method inside it. Then open [http://localhost:8080/comparison/](http://localhost:8080/comparison/) in your favorite browser.
66+
67+
#### Run from command line
68+
69+
Download [source code](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java-Spring/archive/master.zip) from github or clone this repository.
70+
71+
```bash
72+
git clone https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java-Spring
73+
cd GroupDocs.Comparison-for-Java/Demos/Ktor
74+
.\gradlew.bat :run
75+
```
76+
Open [http://localhost:8080/comparison/](http://localhost:8080/comparison/) in your favorite browser.
77+
78+
#### Build distribution archive
79+
80+
Download [source code](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java-Spring/archive/master.zip) from github or clone this repository.
81+
82+
```bash
83+
git clone https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java-Spring
84+
cd GroupDocs.Comparison-for-Java/Demos/Ktor
85+
.\gradlew.bat :build
86+
```
87+
After that, go to `.\build\distributions\` directory to get distribution files.
88+
89+
#### Binary release (with all dependencies)
90+
91+
Download [latest release](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/releases/latest) from [releases page](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/releases).
92+
93+
**Note**: This method is **recommended** for running this sample behind firewall.
94+
95+
```bash
96+
curl -J -L -o release.tar.gz https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/releases/download/v22.3/groupdocs-comparison-ktor-22.3.0.tar
97+
tar -xvzf release.tar.gz
98+
cd release/comparison-ktor-22.3
99+
## Make `bin/comparison-ktor` file to be runnable
100+
bin/comparison-ktor
101+
## Open http://localhost:8080/comparison/ in your favorite browser.
102+
```
103+
104+
## Configuration
105+
You can adjust settings in `/src/main/resources/application.conf` and `/src/main/resources/comparer.conf`. By default, this sample will lookup for license file in `./Licenses` folder, so you can simply put your license file in that folder or specify relative/absolute path by setting `licensePath` value in `/src/main/resources/comparer.conf`.
106+
107+
### Comparison configuration options
108+
109+
| Option | Type | Default value | Description |
110+
|------------------------| ------- |:---------------------:|:---------------------------------------------------------------------------------------------------------------------|
111+
| **`filesDirectory`** | String | `DocumentSamples` | Files directory path. Indicates where uploaded and predefined files are stored. It can be absolute or relative path |
112+
| **`tempDirectory`** | String | system temp directory | Absolute or relative path to directory to save temporary files |
113+
| **`resultDirectory`** | String | `ResultFiles` | Result files directory path. Directory must be created before app starts |
114+
115+
## License
116+
The MIT License (MIT).
117+
118+
Please have a look at the LICENSE.md for more details
119+
120+
## GroupDocs Comparison on other platforms & frameworks
121+
122+
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Compose) with Kotlin in Compose Desktop application
123+
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Dropwizard) with JAVA Dropwizard
124+
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Compose) with Kotlin in Compose Desktop application
125+
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-.NET-MVC) with .NET MVC
126+
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-.NET-WebForms) with .NET WebForms
127+
128+
129+
[Home](https://www.groupdocs.com/) | [Product Page](https://products.groupdocs.com/comparison/java) | [Documentation](https://docs.groupdocs.com/comparison/java/) | [Demos](https://products.groupdocs.app/comparison/family) | [API Reference](https://apireference.groupdocs.com/java/comparison) | [Examples](https://github.com/groupdocs-comparison/GroupDocs.comparison-for-Java/tree/master/Examples) | [Blog](https://blog.groupdocs.com/category/comparison/) | [Free Support](https://forum.groupdocs.com/c/comparison) | [Temporary License](https://purchase.groupdocs.com/temporary-license)

Demos/Ktor/src/main/kotlin/com/groupdocs/ui/config/ComparerConfig.kt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ data class Comparison(
3131
val preloadResultPageCount: Int = 0,
3232
private val previewPageWidth: Int = 0,
3333
private val previewPageRatio: Float = 0f,
34-
private val cacheDirectory: String = "",
3534
private val tempDirectory: String = "",
3635
) {
3736
val filesProviderTypeOrDefault: Defaults.Comparison.FilesProviderType

Demos/Ktor/src/main/resources/comparer.conf

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,6 @@
6060
# Default value is 1.3
6161
previewPageRatio = 0
6262
previewPageRatio = ${?PREVIEW_PAGE_RATIO}
63-
# Absolute or relative path to directory to save cache files
64-
# Default value is system temp directory. The path is always local
65-
cacheDirectory = ""
66-
cacheDirectory = ${?CACHE_DIR}
6763
# Absolute or relative path to directory to save temporary files
6864
# in case of using local files provider, relative path will be resolved with filesDirectory as base path
6965
# Default value is system temp directory. The path is always local

Demos/Spring/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Download [source code](https://github.com/groupdocs-comparison/GroupDocs.Compari
7474

7575
```bash
7676
git clone https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java-Spring
77-
cd GroupDocs.Comparison-for-Java-Spring
77+
cd GroupDocs.Comparison-for-Java/Demos/Spring
7878
mvn package -P war
7979
## Deploy this war on any server
8080
```
@@ -150,7 +150,8 @@ Please have a look at the LICENSE.md for more details
150150

151151
## GroupDocs Comparison on other platforms & frameworks
152152

153-
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java-Dropwizard) with JAVA Dropwizard
153+
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Ktor) with JAVA Ktor
154+
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Dropwizard) with JAVA Dropwizard
154155
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-Java/tree/master/Demos/Compose) with Kotlin in Compose Desktop application
155156
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-.NET-MVC) with .NET MVC
156157
- [Compare documents](https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-.NET-WebForms) with .NET WebForms

0 commit comments

Comments
 (0)