{"id":48362360,"url":"https://github.com/tidemeter/tidemeter","last_synced_at":"2026-04-11T19:01:13.182Z","repository":{"id":349327721,"uuid":"1201623083","full_name":"tidemeter/tidemeter","owner":"tidemeter","description":"Privacy-first self-hosted web analytics ","archived":false,"fork":false,"pushed_at":"2026-04-07T22:16:53.000Z","size":388,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-08T16:03:17.099Z","etag":null,"topics":["privacy-first-analytics","self-hosted-analytics","web-analytics"],"latest_commit_sha":null,"homepage":"https://tidemeter.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tidemeter.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-04-04T23:37:24.000Z","updated_at":"2026-04-07T22:16:48.000Z","dependencies_parsed_at":"2026-04-07T15:01:42.069Z","dependency_job_id":null,"html_url":"https://github.com/tidemeter/tidemeter","commit_stats":null,"previous_names":["tidemeter/tidemeter"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/tidemeter/tidemeter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidemeter%2Ftidemeter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidemeter%2Ftidemeter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidemeter%2Ftidemeter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidemeter%2Ftidemeter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tidemeter","download_url":"https://codeload.github.com/tidemeter/tidemeter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tidemeter%2Ftidemeter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31691503,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-11T13:07:20.380Z","status":"ssl_error","status_checked_at":"2026-04-11T13:06:47.903Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["privacy-first-analytics","self-hosted-analytics","web-analytics"],"created_at":"2026-04-05T13:03:17.261Z","updated_at":"2026-04-11T19:01:13.133Z","avatar_url":"https://github.com/tidemeter.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# TideMeter\n\n**Self-hosted, privacy-focused web analytics**\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)\n[![Built with Next.js](https://img.shields.io/badge/Next.js-16-black)](https://nextjs.org)\n[![PayloadCMS](https://img.shields.io/badge/PayloadCMS-3-blue)](https://payloadcms.com)\n\n\u003c/div\u003e\n\n---\n\n## Features\n\n- **Privacy-focused** — no cookies, no fingerprinting, GDPR-friendly by design\n- **Lightweight tracker** — ~1.5 KB gzipped, zero dependencies\n- **Real-time dashboard** — interactive charts powered by Recharts\n- **Multiple database support** — PostgreSQL, ClickHouse, or SQLite for analytics storage\n- **Built on PayloadCMS 3 + Next.js 16** — modern, extensible full-stack architecture\n- **Docker Compose** — one-command self-hosting\n- **SPA support** — automatic history API interception for single-page apps\n- **Custom event tracking** — track signups, clicks, purchases, anything\n- **Team collaboration** — multi-user with role-based access\n- **API for programmatic access** — query your analytics data from anywhere\n\n## Quick Start (Docker)\n\n```bash\ngit clone https://github.com/your-org/tidemeter.git\ncd tidemeter\ncp .env.example .env\n# Edit .env with your settings (at minimum, change PAYLOAD_SECRET and SESSION_SALT_SECRET)\ndocker compose -f docker/docker-compose.yml up -d\n```\n\nVisit **http://localhost:3700** to create your admin account and add your first website.\n\n\u003e **Documentation**: Full docs available at [tidemeter.com/docs](https://tidemeter.com/docs)\n\n## Development Setup\n\n### Prerequisites\n\n- [Node.js](https://nodejs.org) 22+\n- [pnpm](https://pnpm.io) 9+\n- [PostgreSQL](https://www.postgresql.org) 16+ (or use Docker for the database)\n\n### Install \u0026 Run\n\n```bash\n# Install dependencies\npnpm install\n\n# Create your environment file\ncp .env.example .env\n# Edit .env — point DATABASE_URL / ANALYTICS_DATABASE_URL to your PostgreSQL instance\n\n# Start all packages in dev mode\npnpm dev\n\n# Build for production\npnpm build\n\n# Run tests\npnpm test\n\n# Lint\npnpm lint\n\n# Run analytics database migrations\npnpm db:migrate\n```\n\nThe dev server starts at **http://localhost:3700** with Turbopack HMR.\n\n## Adding the Tracker\n\nAdd the tracking script to any website you want to monitor. The `data-website-id` comes from your TideMeter dashboard after adding a site.\n\n```html\n\u003cscript\n  defer\n  data-website-id=\"YOUR_WEBSITE_ID\"\n  src=\"https://your-tidemeter-domain.com/t.js\"\n\u003e\u003c/script\u003e\n```\n\n### Script Attributes\n\n| Attribute          | Description                                   | Default       |\n| ------------------ | --------------------------------------------- | ------------- |\n| `data-website-id`  | **(required)** Website ID from your dashboard | —             |\n| `data-host-url`    | Override the analytics endpoint URL           | Script origin |\n| `data-auto-track`  | Auto-track pageviews                          | `true`        |\n| `data-respect-dnt` | Respect the Do-Not-Track header               | `true`        |\n| `data-domains`     | Comma-separated list of allowed domains       | All domains   |\n\n### Custom Events\n\n```javascript\n// Track a named event\ntidemeter.track(\"signup\", { plan: \"pro\" });\n\n// Track a pageview manually (when auto-track is disabled)\ntidemeter.track();\n```\n\n## Architecture\n\nTideMeter is a **Turborepo monorepo** with a clear separation between the application layer and the analytics data layer.\n\n```\n┌─────────────────────────────────────────────┐\n│                  apps/web                   │\n│        Next.js 16 + PayloadCMS 3            │\n│     (dashboard, admin, API routes)          │\n├──────────────┬──────────────┬───────────────┤\n│ @tidemeter/  │ @tidemeter/  │ @tidemeter/   │\n│   tracker    │  analytics   │      ui       │\n│  (t.js)      │ (Drizzle ORM)│  (components) │\n└──────────────┴──────┬───────┴───────────────┘\n                      │\n          ┌───────────┼───────────┐\n          │           │           │\n      PostgreSQL  ClickHouse   SQLite\n```\n\n- **Dual database design** — PayloadCMS manages application data (users, sites, settings) in PostgreSQL; analytics events are stored in a separate database that can be PostgreSQL, ClickHouse, or SQLite.\n- **Repository pattern** — the `@tidemeter/analytics` package defines an `AnalyticsRepository` interface with swappable adapters (`postgres`, `clickhouse`), selected at runtime via the `ANALYTICS_DB_TYPE` env var.\n- **Tracker** — `@tidemeter/tracker` compiles to a single `t.js` file via Rollup, served as a static asset.\n\n## Configuration\n\nAll configuration is done through environment variables. Copy `.env.example` to `.env` and adjust:\n\n| Variable                 | Description                                                    | Default                                                     |\n| ------------------------ | -------------------------------------------------------------- | ----------------------------------------------------------- |\n| `DATABASE_URL`           | PostgreSQL connection string for PayloadCMS                    | `postgresql://tidemeter:tidemeter@localhost:5432/tidemeter` |\n| `PAYLOAD_SECRET`         | Secret for PayloadCMS auth (min 32 chars)                      | —                                                           |\n| `ANALYTICS_DB_TYPE`      | Analytics storage engine: `postgresql`, `clickhouse`, `sqlite` | `postgresql`                                                |\n| `ANALYTICS_DATABASE_URL` | Connection string for analytics DB (PostgreSQL)                | Same as `DATABASE_URL`                                      |\n| `CLICKHOUSE_URL`         | ClickHouse HTTP endpoint                                       | `http://localhost:8123`                                     |\n| `CLICKHOUSE_DATABASE`    | ClickHouse database name                                       | `tidemeter_analytics`                                       |\n| `ANALYTICS_SQLITE_PATH`  | Path to SQLite file (when using SQLite)                        | `./data/analytics.db`                                       |\n| `NEXT_PUBLIC_APP_URL`    | Public URL of the application                                  | `http://localhost:3000`                                     |\n| `SESSION_SALT_SECRET`    | Secret for hashing visitor IDs (rotated daily)                 | —                                                           |\n| `GEOIP_DB_PATH`          | Path to MaxMind GeoLite2-City.mmdb (optional)                  | —                                                           |\n\nSee [`.env.example`](.env.example) for the full annotated reference.\n\n## ClickHouse Mode\n\nFor high-traffic sites, use ClickHouse as the analytics storage engine. The override compose file adds a ClickHouse container and reconfigures the app:\n\n```bash\ndocker compose -f docker/docker-compose.yml -f docker/docker-compose.ch.yml up -d\n```\n\nThis starts PostgreSQL (for PayloadCMS) + ClickHouse (for analytics) + the TideMeter app.\n\n## Tech Stack\n\n| Layer         | Technology                       |\n| ------------- | -------------------------------- |\n| Framework     | Next.js 16                       |\n| CMS           | PayloadCMS 3                     |\n| Styling       | Tailwind CSS 4                   |\n| Charts        | Recharts                         |\n| State         | React Hooks                      |\n| Analytics ORM | Drizzle ORM                      |\n| Build         | Turborepo + pnpm                 |\n| Runtime       | Node.js 22 (Alpine)              |\n| Docker        | Multi-stage Dockerfile + Compose |\n\n## Project Structure\n\n```\ntidemeter/\n├── apps/\n│   └── web/                 # Next.js 16 + PayloadCMS application\n├── packages/\n│   ├── analytics/           # Analytics data layer (Drizzle ORM, adapters)\n│   │   └── src/\n│   │       ├── adapters/    # postgres, clickhouse implementations\n│   │       ├── schema/      # Drizzle table definitions\n│   │       ├── types.ts     # Core interfaces (AnalyticsRepository, etc.)\n│   │       └── factory.ts   # Adapter factory\n│   ├── tracker/             # Lightweight tracking script (Rollup → t.js)\n│   ├── ui/                  # Shared UI components\n│   └── tsconfig/            # Shared TypeScript configs\n├── docker/\n│   ├── Dockerfile           # Multi-stage production build\n│   ├── docker-compose.yml   # Default stack (PostgreSQL)\n│   ├── docker-compose.ch.yml # ClickHouse override\n│   └── clickhouse/          # ClickHouse init scripts\n├── turbo.json               # Turborepo pipeline config\n├── pnpm-workspace.yaml      # pnpm workspace definition\n└── package.json             # Root scripts (dev, build, test, lint)\n```\n\n## License\n\n[MIT](LICENSE) © 2026 TideMeter\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftidemeter%2Ftidemeter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftidemeter%2Ftidemeter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftidemeter%2Ftidemeter/lists"}