🔬
Product Docs
  • 👋Welcome to Web3 Analytics
  • Overview
    • ✨Features
    • 💡How does it work?
  • Fundamentals
    • 🛠️Getting set up
      • 📝Register an app
      • 🔧Install via NPM
      • 🔨Install via CDN
      • ⚙️Instrumenting your app
  • Product Guides
    • ❓Creating queries
    • 📊Making a dashboard
    • ✔️Sample apps
  • Technology
    • Why Web3 Analytics?
    • Front end instrumentation
    • Decentralized data network
    • Smart contract registry
    • Indexer
    • Dashboard builder
    • Source code
Powered by GitBook
On this page
  1. Fundamentals
  2. Getting set up

Install via NPM

PreviousRegister an appNextInstall via CDN

Last updated 2 years ago

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

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:

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

And initialize and configure like this:

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 for reference.

🛠️
🔧
example app