How to Run Examples

The complete project GroupDocs.Conversion for Node.js via Java — Code Examples with runnable examples and sample files is hosted on GitHub. The structure and commands below are based on this repository and its README.

Prerequisites

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

  • Node.js: 20 LTS or later
  • Java: JRE/JDK 8+ (17 LTS recommended)
  • Java environment: JAVA_HOME set and added to PATH

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

For more details, see the examples repository README:
GroupDocs.Conversion for Node.js via Java — Code Examples README.

Run examples using npm

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

  1. Clone the repository with examples

    git clone https://github.com/groupdocs-conversion/GroupDocs.Conversion-for-Node.js-via-Java.git
    cd GroupDocs.Conversion-for-Node.js-via-Java
    
  2. Install dependencies

    npm install
    

    This installs the bundled groupdocs-conversion-<version>.tgz package and other dependencies defined in package.json.
    If installation fails with native build errors, review the build tools section in System Requirements.

  3. Run all examples

    npm start
    

    Output documents are created under the ./Examples/Output/ directory

Explore available examples

After running the project once, you may want to see what examples are available and how they are organized:

  • Open examples.js and runExamples.js to review the list of functions being called.

  • Enable or disable specific examples by editing runExamples.js and re-running:

    npm start
    

Refer to the examples README for an overview of QuickStart, BasicUsage, and AdvancedUsage folders and the scenarios they cover.

Close
Loading

Analyzing your prompt, please hold on...

An error occurred while retrieving the results. Please refresh the page and try again.