How to Run Examples Leave feedback

Prerequisites

Before running examples, make sure your environment meets the System Requirements and Installation guides:

Windows PowerShell:

$env:JAVA_HOME="C:\Program Files\Java\jdk-17"
$env:Path="$env:JAVA_HOME\bin;$env:Path"

Linux/macOS:

export JAVA_HOME=/usr/lib/jvm/java-17
export PATH=$JAVA_HOME/bin:$PATH

To get started, make sure that Node.js and Java are installed and configured as described above.

Clone the repository with examples

git clone git@github.com:groupdocs-total/GroupDocs.Total-for-Node.js-via-Java.git

Navigate to the Examples folder

cd ./GroupDocs.Total-for-Node.js-via-Java/Examples

Install dependencies
```
npm install
```
This pulls @groupdocs/groupdocs.total from npm. We typically keep the dependency on the latest published version; to use another version, change it in package.json.
If installation fails with native build errors, review the build tools section in System Requirements.
Configure license (optional)
If you have a license file, you can set the license path in the run_all_examples.js file. By default, the runner checks for the GROUPDOCS_LICENSE_PATH (or GROUPDOCS_LIC_PATH) environment variable or looks for files with the .lic extension in the Examples directory. You can also get a temporary license to test all the features.
Without a license the APIs run in evaluation mode and add trial watermarks to output.
Run all examples
```
npm start
```
List every example, then run one on its own:
```
node run_all_examples.js --list
node run_all_examples.js --example ViewerRenderToHtml
```
You can also run an individual example by navigating to the folder containing the example script and running it. Output files are placed in the same folder as the script file.

We also offer GroupDocs.Total packages for other platforms:

We value your opinion. Your feedback will help us improve our documentation.