> For the complete documentation index, see [llms.txt](https://web3-analytics.gitbook.io/product-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://web3-analytics.gitbook.io/product-docs/fundamentals/getting-set-up/install-via-npm.md).

# Install via NPM

Personalized instructions for installing your app can be found in the 'How to install' tab of your App dashboard.

<figure><img src="/files/m4kfRsjijeRsVg87fVhE" alt=""><figcaption></figcaption></figure>

## How to install via NPM

If your app uses a package manager like npm, you can install Web3 Analytics like this:

```
npm install analytics analytics-plugin-web3analytics
```

At the top level of your app, import Web3 Analytics like this:

```javascript
import Analytics from 'analytics'
import web3Analytics from 'analytics-plugin-web3analytics'
```

And initialize and configure like this:

```javascript
const analytics = Analytics({
  app: 'awesome-app',
  plugins: [
    web3Analytics({
      appId: 'YOUR_APP_ID',
      jsonRpcUrl: 'https://eth-goerli.g.alchemy.com/v2/your_key_here'
    })
  ]
})
```

You can use any app name you like. For appId, input your appId (it will be displayed in the instructions and is also visible on the details tab of the app dashboard. You will also need to use your own jsonRpcUrl for Goerli.

Here is an [example app](https://github.com/andyjagoe/web3-analytics-demo) for reference.

<figure><img src="/files/LFtStpaeFTlKYLi3Gp1W" alt=""><figcaption></figcaption></figure>


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://web3-analytics.gitbook.io/product-docs/fundamentals/getting-set-up/install-via-npm.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.