> For the complete documentation index, see [llms.txt](https://docs.apryse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apryse.com/web/what-is-webviewer/run-samples.md).

# Running WebViewer samples locally

Discover project samples with the WebViewer library package. Easily set up and run samples for testing and troubleshooting. Learn more on how to navigate and utilize these valuable resources. The Apry

Along with the WebViewer library package are project samples that are available to try. They are found in the `samples` directory after extracting the Webviewer package. The samples are the same that are found on the [Apryse site](/web/get-started/guides/samples/viewing.md) and are readily available as a reference to assist you in your project. The samples are also a good way to test, compare, and troubleshoot issues in your own project.

## Running samples

You can easily and quickly set up the package to run the samples.

{% @apryse-download-button/apryse-download-button id="WebViewer\_web\_web" title="Download WebViewer" showVersion="true" %}

1. Extract the WebViewer package (`WebViewer.zip`). The WebViewer package is prepared to host the samples and WebViewer library (lib folder) out of the box.
2. Open a terminal at the extracted `WebViewer` folder location.
3. Install the required dependencies to run the samples by executing:

{% tabs %}
{% tab title="Shell" %}
{% code lineNumbers="true" %}

```sh
npm install
```

{% endcode %}
{% endtab %}
{% endtabs %}

1. Next run the samples by executing:

{% tabs %}
{% tab title="Shell" %}
{% code lineNumbers="true" %}

```sh
npm start
```

{% endcode %}
{% endtab %}
{% endtabs %}

You should see a message that reads

{% tabs %}
{% tab title="Shell" %}
{% code lineNumbers="true" %}

```sh
Listening at localhost:3000
```

{% endcode %}
{% endtab %}
{% endtabs %}

1. Navigate to `localhost:3000` and you will be taken to the page with the samples.

![](https://3532544125-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX9YnTSKIHvV7m0A36LbO%2Fuploads%2Fgit-blob-f835a32705bd4ffbba5defbc15c89fb9a05b8cf4%2Fbf24f5f09a32647fdba2f3b341b77b8b074b6b4f-1920x845.png?alt=media)

## Next step

<a href="/web/what-is-webviewer/usage.md" class="button primary">Usage</a><a href="/web/get-started/guides.md" class="button primary">Guides</a><a href="/web/get-started/samples.md" class="button primary">Samples</a><a href="https://sdk.apryse.com/api/web/index.html" class="button primary">API docs</a>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.apryse.com/web/what-is-webviewer/run-samples.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
