Quick Start

1. Install the Package

npm install locallytics

2. Set Up the Server

Create an API route handler with your database connection:

app/api/locallytics/route.ts

import { locallytics } from "locallytics";

export const analytics = await locallytics({
  database: process.env.DATABASE_URL!,
});

export const { GET, POST } = analytics;

3. Run Migrations

Generate and run the database schema:

# Generate schema (creates ./locallytics/schema.sql)
npx @locallytics/cli generate

# Run migrations
npx @locallytics/cli migrate

4. Add the Analytics Grabber

Add <AnalyticsGrabber /> to your root layout:

app/layout.tsx

import { AnalyticsGrabber } from "locallytics";

export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html>
      <body>
        {children}
        <AnalyticsGrabber />
      </body>
    </html>
  );
}

5. Fetch Analytics Data

Create a page to display your analytics:

app/analytics/page.tsx

import { AnalyticsJSON } from "locallytics";
import { headers } from "next/headers";

export default async function AnalyticsPage() {
  const data = await AnalyticsJSON({ headersReader: headers });

  return (
    <div>
      <h1>Pageviews: {data.pageviews}</h1>
      <h2>Unique Visitors: {data.uniqueVisitors}</h2>
      <pre>{JSON.stringify(data, null, 2)}</pre>
    </div>
  );
}

What's Next?

Check out the API Reference for more details
Learn about available metrics and how to track custom events