Install GroupDocs.Viewer for Node.js via Java Leave feedback

Welcome to the installation guide for the GroupDocs.Viewer package! This guide will help you set up the package for your Node.js application.

Before you begin, please ensure that your system meets the necessary requirements. You can find detailed information about the system requirements at System Requirements.

In this guide, you will find step-by-step instructions for installing the package via npm, adding it manually, and troubleshooting common installation issues. Let’s get started!

To install the GroupDocs.Viewer package using NPM, follow these steps:

1. Open a Terminal
   Make sure you are in your project directory where you want to install the package.

2. Run the following command to install the GroupDocs.Viewer package:

   npm install @groupdocs/groupdocs.viewer
   

   Tip

   In case you’re using NPM version lower than 5 add --save switch. You can check NPM version by typing npm -v in your terminal.

3. Expected Console Output
   Once you run the command, you should see output similar to the following:

    added 109 packages, and audited 110 packages in 2m
   
    14 packages are looking for funding
      run `npm fund` for details
   
    found 0 vulnerabilities
   

   This confirms that the package was installed successfully. The package version number and other details in the output may vary depending on your environment.

4. Verify Installation
   You can verify the installation by checking the package.json file in your project directory. You should see groupdocs-viewer listed under dependencies:

   {
     "dependencies": {
       "@groupdocs/groupdocs.viewer": "^<version-number>"
     }
   }
   

You can now proceed to using the package in your JavaScript code. If you prefer to install the package manually or need further details, check the next sections.

In cases where you prefer to add the @groupdocs/groupdocs.viewer package manually, follow these steps:

1. Open the package.json file located in your project’s root directory.

2. Add the GroupDocs.Viewer dependency in the dependencies section, as shown below:

   {
     "dependencies": {
       "@groupdocs/groupdocs.viewer": "^<version-number>"
     }
   }
   

   Tip

   You can find actual @groupdocs/groupdocs.viewer package version at the package page on NPM.

3. Save the package.json file.

4. Install the dependencies by running the following command:

   npm install
   

This will install the GroupDocs.Viewer package based on the version specified in your package.json file.

Once you have installed the GroupDocs.Viewer package, here’s a minimal example of how you can use it in a Node.js application.

1. Create a JavaScript file (e.g., app.js) in your project’s root directory.

2. Import the GroupDocs.Viewer module and implement a simple file viewing functionality:

   app.js

    const gdv = require('@groupdocs/groupdocs.viewer')
   
    // Path to the file you want to render
    const filePath = 'sample.pdf';
   
    // Initialize viewer
    const viewer = new gdv.Viewer(filePath);
   
    // Render the file to HTML
    viewer.view(gdv.HtmlViewOptions.forEmbeddedResources());
   
    // Exit with a success code
    process.exit(0);
   

   sample-app.zip

   The sample-app.zip is a sample Node.js application that you can download to get started.

3. Run the app by executing the following command in your terminal:

   node app.js
   

This minimal example converts a document to HTML format. The output will contain rendered pages in HTML format.

Here are some troubleshooting tips for common installation issues you may encounter while setting up the GroupDocs.Viewer package:

1. Ensure Node.js is Installed

   • Verify that you have Node.js installed on your machine. You can check the installation by running the following command:

     node -v
     

   • If Node.js is not installed, download and install it from the official Node.js website.

2. Ensure Java is Installed

   • GroupDocs.Viewer may require Java for certain functionalities. Verify that Java is installed on your machine by running:

     java -version
     

   • If Java is not installed, download and install it from the official Oracle website or OpenJDK or Microsoft Build of OpenJDK.

3. Check npm Version

   • Ensure you are using a compatible version of npm. You can check your npm version by running:

     npm -v
     

   • If you have an outdated version, consider updating it:

     npm install -g npm@latest
     

4. Clear npm Cache

   • Sometimes, corrupted cache can cause installation issues. You can clear the npm cache by running:

     npm cache clean --force
     

5. Verify Dependency Installation

   • If you encounter issues related to dependencies not being installed, ensure that your package.json file is correctly configured. You can manually add the groupdocs-viewer entry in the dependencies section and then run:

     npm install
     

6. Check for Permission Issues

   • If you encounter permission errors during installation, try running the command with elevated privileges:

     sudo npm install @groupdocs/groupdocs.viewer
     

   • Alternatively, consider setting up a Node version manager like nvm to avoid permission issues with global installations.

7. Reach Out for Support

   • If you continue to experience issues, consider reaching out our Free Support Forum for assistance.