Skip to content

Commit 21a2887

Browse files
Update how-to-run-examples
1 parent befbe42 commit 21a2887

1 file changed

Lines changed: 26 additions & 21 deletions

File tree

nodejs-java/getting-started/how-to-run-examples.md

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -44,43 +44,48 @@ To get started, make sure that [Node.js](https://nodejs.org/) and Java are insta
4444
1. **Clone the repository with examples**
4545

4646
```bash
47-
git clone https://github.com/groupdocs-viewer/GroupDocs.Viewer-for-Node.js-via-Java.git
48-
cd GroupDocs.Viewer-for-Node.js-via-Java
47+
git clone git@github.com:groupdocs-viewer/GroupDocs.Viewer-for-Node.js-via-Java.git
4948
```
5049

51-
2. **Install dependencies**
50+
2. **Navigate to the `Examples` folder**
5251

5352
```bash
54-
npm install
53+
cd ./GroupDocs.Viewer-for-Node.js-via-Java/Examples
5554
```
5655

57-
This installs the bundled `groupdocs-groupdocs.viewer-<version>.tgz` package and other dependencies defined in `package.json`.
58-
If installation fails with native build errors, review the build tools section in [System Requirements]({{< ref "viewer/nodejs-java/getting-started/system-requirements" >}}).
56+
3. **Install dependencies**
57+
58+
```bash
59+
npm install
60+
```
5961

60-
3. **Run all examples**
62+
This installs the bundled `groupdocs.viewer-<version>.tgz` package and other dependencies defined in `package.json`. We typically keep the package up to date with the latest version. If you need to use a different package version, you can update the `package.json` file accordingly.
6163

64+
Alternatively, you can download the `tgz` file from the official [GroupDocs Releases](https://releases.groupdocs.com/viewer/nodejs-java/#direct-download) website. To install the package manually, copy the tgz file to the `Examples` directory and run the following command:
65+
6266
```bash
63-
npm start
67+
npm install ./groupdocs.viewer-*.tgz
6468
```
6569

66-
Output documents are created under the `Output/` directory, grouped by example.
70+
If installation fails with native build errors, review the build tools section in [System Requirements]({{< ref "viewer/nodejs-java/getting-started/system-requirements" >}}).
6771

68-
## Explore available examples
72+
4. **Configure license (optional)**
6973

70-
After running the project once, you may want to see what examples are available and how they are organized:
74+
If you have a license file, you can set the license path in the `run_all_examples.js` file. By default, GroupDocs.Viewer for Node.js via Java checks for the `GROUPDOCS_LICENSE_PATH` environment variable or looks for files with the `.lic` extension in the project's root directory. You can also [get a temporary license](https://purchase.groupdocs.com/temporary-license) to test all the features.
7175

72-
- Open `examples.js` and `runExamples.js` to review the list of functions being called.
73-
- Enable or disable specific examples by editing `runExamples.js` and re-running:
76+
5. **Run all examples**
7477

75-
```bash
76-
npm start
77-
```
78+
```bash
79+
npm start
80+
```
7881

79-
Refer to the examples README for an overview of QuickStart, BasicUsage, and AdvancedUsage folders and the scenarios they cover
80-
([README](https://raw.githubusercontent.com/groupdocs-viewer/GroupDocs.Viewer-for-Node.js-via-Java/refs/heads/master/README.md)).
82+
You can also run individual examples by navigating to the folder containing the example script and running it. Output files are placed in the same folder as the script file.
8183

82-
## Contribute
84+
## More Resources
8385

84-
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.
86+
Find additional details and examples in the [GroupDocs.Viewer for Node.js via Java documentation](https://docs.groupdocs.com/viewer/nodejs-java/).
8587

86-
To contribute, you can fork the repository, edit the source code and create a pull request. We will review the changes and include them in the repository if found helpful.
88+
We also offer **GroupDocs.Viewer** packages for other platforms:
89+
* [**GroupDocs.Viewer for .NET**](https://products.groupdocs.com/viewer/net/)
90+
* [**GroupDocs.Viewer for Java**](https://products.groupdocs.com/viewer/java/)
91+
* [**GroupDocs.Viewer for Python via .NET**](https://products.groupdocs.com/viewer/python-net/)

0 commit comments

Comments
 (0)