MunyayLLC · vercel · Dec 20, 2025
diff --git a/docs/vercel-web-analytics.md b/docs/vercel-web-analytics.md
@@ -0,0 +1,331 @@
+# Getting Started with Vercel Web Analytics
+
+This guide will help you get started with using Vercel Web Analytics on your project built with the OnChainTestKit, showing you how to enable it, add the package to your project, deploy your app to Vercel, and view your data in the dashboard.
+
+## Prerequisites
+
+- A Vercel account. If you don't have one, you can [sign up for free](https://vercel.com/signup).
+- A Vercel project. If you don't have one, you can [create a new project](https://vercel.com/new).
+- The Vercel CLI installed. If you don't have it, you can install it using the following command:
+
+```bash
+# Using pnpm
+pnpm i vercel
+
+# Using yarn
+yarn add vercel
+
+# Using npm
+npm i vercel
+
+# Using bun
+bun add vercel
+```
+
+## Enable Web Analytics in Vercel
+
+On the [Vercel dashboard](/dashboard), select your Project and then click the **Analytics** tab and click **Enable** from the dialog.
+
+> **💡 Note:** Enabling Web Analytics will add new routes (scoped at `/_vercel/insights/*`) after your next deployment.
+
+## Add `@vercel/analytics` to Your Project
+
+Using the package manager of your choice, add the `@vercel/analytics` package to your project:
+
+```bash
+# Using pnpm
+pnpm add @vercel/analytics
+
+# Using yarn
+yarn add @vercel/analytics
+
+# Using npm
+npm install @vercel/analytics
+
+# Using bun
+bun add @vercel/analytics
+```
+
+## Framework-Specific Integration
+
+Select your framework below to view integration instructions:
+
+### Next.js (Pages Router)
+
+If you are using the `pages` directory, add the following code to your main app file:
+
+```tsx
+// pages/_app.tsx
+import type { AppProps } from "next/app";
+import { Analytics } from "@vercel/analytics/next";
+
+function MyApp({ Component, pageProps }: AppProps) {
+  return (
+    <>
+      <Component {...pageProps} />
+      <Analytics />
+    </>
+  );
+}
+
+export default MyApp;
+```
+
+### Next.js (App Router)
+
+Add the following code to the root layout:
+
+```tsx
+// app/layout.tsx
+import { Analytics } from "@vercel/analytics/next";
+
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  return (
+    <html lang="en">
+      <head>
+        <title>Your App</title>
+      </head>
+      <body>
+        {children}
+        <Analytics />
+      </body>
+    </html>
+  );
+}
+```
+
+### React / Create React App
+
+The `Analytics` component is a wrapper around the tracking script, offering more seamless integration with React.
+
+**💡 Note:** When using the plain React implementation, there is no route support.
+
+Add the following code to the main app file:
+
+```tsx
+// App.tsx
+import { Analytics } from "@vercel/analytics/react";
+
+export default function App() {
+  return (
+    <div>
+      {/* ... */}
+      <Analytics />
+    </div>
+  );
+}
+```
+
+### Remix
+
+The `Analytics` component is a wrapper around the tracking script, offering a seamless integration with Remix, including route detection.
+
+Add the following code to your root file:
+
+```tsx
+// app/root.tsx
+import {
+  Links,
+  LiveReload,
+  Meta,
+  Outlet,
+  Scripts,
+  ScrollRestoration,
+} from "@remix-run/react";
+import { Analytics } from "@vercel/analytics/remix";
+
+export default function App() {
+  return (
+    <html lang="en">
+      <head>
+        <meta charSet="utf-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+        <Meta />
+        <Links />
+      </head>
+      <body>
+        <Analytics />
+        <Outlet />
+        <ScrollRestoration />
+        <Scripts />
+        <LiveReload />
+      </body>
+    </html>
+  );
+}
+```
+
+### SvelteKit
+
+The `injectAnalytics` function is a wrapper around the tracking script, offering more seamless integration with SvelteKit, including route support.
+
+Add the following code to the main layout:
+
+```ts
+// src/routes/+layout.ts
+import { dev } from "$app/environment";
+import { injectAnalytics } from "@vercel/analytics/sveltekit";
+
+injectAnalytics({ mode: dev ? "development" : "production" });
+```
+
+### Astro
+
+The `Analytics` component is a wrapper around the tracking script, offering more seamless integration with Astro, including route support.
+
+Add the following code to your base layout:
+
+```astro
+---
+// src/layouts/Base.astro
+import Analytics from '@vercel/analytics/astro';
+---
+
+<html lang="en">
+	<head>
+      <meta charset="utf-8" />
+      <!-- ... -->
+      <Analytics />
+	</head>
+	<body>
+		<slot />
+    </body>
+</html>
+```
+
+> **💡 Note:** The `Analytics` component is available in version `@vercel/analytics@1.4.0` and later.
+> If you are using an earlier version, you must configure the `webAnalytics` property of the Vercel adapter in your `astro.config.mjs` file as shown below.
+> For further information, see the [Astro adapter documentation](https://docs.astro.build/en/guides/integrations-guide/vercel/#webanalytics).
+
+```js
+// astro.config.mjs
+import { defineConfig } from "astro/config";
+import vercel from "@astrojs/vercel/serverless";
+
+export default defineConfig({
+  output: "server",
+  adapter: vercel({
+    webAnalytics: {
+      enabled: true, // set to false when using @vercel/analytics@1.4.0
+    },
+  }),
+});
+```
+
+### Vue
+
+The `Analytics` component is a wrapper around the tracking script, offering more seamless integration with Vue.
+
+**💡 Note:** Route support is automatically enabled if you're using `vue-router`.
+
+Add the following code to your main component:
+
+```vue
+<!-- src/App.vue -->
+<script setup lang="ts">
+import { Analytics } from '@vercel/analytics/vue';
+</script>
+
+<template>
+  <Analytics />
+  <!-- your content -->
+</template>
+```
+
+### Nuxt
+
+The `Analytics` component is a wrapper around the tracking script, offering more seamless integration with Nuxt, including route support.
+
+Add the following code to your main component:
+
+```vue
+<!-- app.vue -->
+<script setup lang="ts">
+import { Analytics } from '@vercel/analytics/nuxt';
+</script>
+
+<template>
+  <Analytics />
+  <NuxtPage />
+</template>
+```
+
+### Plain HTML
+
+For plain HTML sites, you can add the following script to your `.html` files:
+
+```html
+<!-- index.html -->
+<script>
+  window.va = window.va || function () { (window.vaq = window.vaq || []).push(arguments); };
+</script>
+<script defer src="/_vercel/insights/script.js"></script>
+```
+
+**💡 Note:** When using the HTML implementation, there is no need to install the `@vercel/analytics` package. However, there is no route support.
+
+### Other Frameworks
+
+For frameworks not listed above, you can use the `inject` function from the package, which will add the tracking script to your app. **This should only be called once in your app, and must run in the client**.
+
+**💡 Note:** There is no route support with the `inject` function.
+
+Add the following code to your main app file:
+
+```ts
+// main.ts
+import { inject } from "@vercel/analytics";
+
+inject();
+```
+
+## Deploy Your App to Vercel
+
+Deploy your app using the following command:
+
+```bash
+vercel deploy
+```
+
+If you haven't already, we also recommend [connecting your project's Git repository](/docs/git#deploying-a-git-repository), which will enable Vercel to deploy your latest commits to main without terminal commands.
+
+Once your app is deployed, it will start tracking visitors and page views.
+
+> **💡 Note:** If everything is set up properly, you should be able to see a Fetch/XHR request in your browser's Network tab from `/_vercel/insights/view` when you visit any page.
+
+## View Your Data in the Dashboard
+
+Once your app is deployed, and users have visited your site, you can view your data in the dashboard.
+
+To do so, go to your [dashboard](/dashboard), select your project, and click the **Analytics** tab.
+
+After a few days of visitors, you'll be able to start exploring your data by viewing and filtering the panels.
+
+Users on Pro and Enterprise plans can also add custom events to their data to track user interactions such as button clicks, form submissions, or purchases.
+
+Learn more about how Vercel supports [privacy and data compliance standards](/docs/analytics/privacy-policy) with Vercel Web Analytics.
+
+## Next Steps
+
+Now that you understand how to set up Vercel Web Analytics, you can explore the following topics to learn more:
+
+- [Learn how to use the `@vercel/analytics` package](/docs/analytics/package)
+- [Learn how to set update custom events](/docs/analytics/custom-events)
+- [Learn about filtering data](/docs/analytics/filtering)
+- [Read about privacy and compliance](/docs/analytics/privacy-policy)
+- [Explore pricing](/docs/analytics/limits-and-pricing)
+- [Troubleshooting](/docs/analytics/troubleshooting)
+
+## Using Analytics with OnChainTestKit
+
+If you're building a test application or dashboard that uses OnChainTestKit for blockchain testing, you can integrate Vercel Web Analytics by:
+
+1. Setting up Vercel Web Analytics in your frontend application (following the appropriate framework-specific guide above)
+2. Ensuring OnChainTestKit dependencies are properly installed alongside your analytics integration
+3. Deploying your application to Vercel to start collecting analytics data about how your test application is being used
+
+This allows you to track user interactions with your blockchain testing application and gather insights into testing patterns and usage.