How to Run Examples

Warning
Make sure that GroupDocs.Comparison has been installed properly before running examples.

We offer multiple solutions on how you can run GroupDocs.Comparison examples, by building your own or using our back-end or front-end examples out-of-the-box.

Please choose one from the following list:

Build project from scratch

  1. Open Visual Studio and navigate to File -> New -> Project.
  2. Select the appropriate project type - Console App, ASP.NET Web Application etc.
  3. Install GroupDocs.Comparison for .NET from Nuget or official GroupDocs website following the guide.
  4. Develop your first application with GroupDocs.Comparison for .NET like shown below:
string sourceDocumentPath = @"C:\source.docx"; // NOTE: Put here actual path to source document
string targetDocumentPath = @"C:\target.docx"; // NOTE: Put here actual path to source document
string outputPath = @"C:\result.docx"; // NOTE: Put here actual path to source document

using (Comparer comparer = new Comparer(sourceDocumentPath))
{
    comparer.Add(targetDocumentPath);
    comparer.Compare(outputPath);
}
  1. Build and run your project.
  2. Check the rendered document pages at path specified in the “outputPath” parameter.

Run back-end examples

The GitHub hosts the complete GroupDocs.Comparison examples package. You can either download the ZIP file or clone the GitHub repository using your favorite git client.
If you download the ZIP file, extract it content to your local disk. The extracted files and folders will look as follows:

In extracted files and folders, you can find CSharp solution file. The project is created using Visual Studio 2019. The Resources folder contains all the sample document and image files used in the examples.
To run the examples, open the solution file in Visual Studio and build the project. To add missing references of GroupDocs.Comparison see the installation guide. The RunExamples.cs calls all the functions. Uncomment the function to run and comment the rest.

Run MVC examples

To run GroupDocs.Comparison for .NET MVC Example, follow these steps:

  1. Download source code from GitHub or clone this repository:

    git clone https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-.NET-MVC
    

  2. Open solution in the VisualStudio. Update common parameters in web.config and example related properties in the configuration.yml to meet your requirements.

  3. Open http://localhost:8080/comparison in your favorite browser

For more details about project configuration please refer to this guide.

Run WebForms examples

You can run GroupDocs.Comparison for .NET Web.Forms Example following these steps:

  1. Download the source code from GitHub or clone the repository:
git clone https://github.com/groupdocs-comparison/GroupDocs.Comparison-for-.NET-WebForms
  1. Open solution in the VisualStudio. Update common parameters in web.config and example related properties in the configuration.yml to meet your requirements.
  2. Open http://localhost:8080/comparison in browser.

For details, see the guide.

Run using Docker

Use the Docker image to try GroupDocs.Comparison for .NET features in an easy way. Execute the following commands to run GroupDocs.Comparison for .NET from docker image:

mkdir DocumentSamples
mkdir Licenses
docker run -p 8080:8080 --env application.hostAddress=localhost -v `pwd`/DocumentSamples:/home/groupdocs/app/DocumentSamples -v `pwd`/Licenses:/home/groupdocs/app/Licenses groupdocs/comparison
## Open http://localhost:8080/comparison in your favorite browser.

Contribute

If you like to add or improve an example, we encourage you to contribute to the project. All examples in this repository are open source and can be freely used in your own applications.
To contribute, you can fork the repository, edit the code and create a pull request. We will review the changes and include it in the repository if found helpful.