{"id":30680471,"url":"https://github.com/remcostoeten/hono-analytics","last_synced_at":"2025-09-01T16:04:27.337Z","repository":{"id":311366114,"uuid":"1043322769","full_name":"remcostoeten/hono-analytics","owner":"remcostoeten","description":"Self-hosted analytics built with HONO, TypeScript \u0026 modern web tech. Privacy-focused, lightweight, developer-friendly.","archived":false,"fork":false,"pushed_at":"2025-08-24T02:38:20.000Z","size":309,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-24T11:20:45.541Z","etag":null,"topics":["analytics","edge-runtime","hono","privacy","self-hosted","typescript"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/remcostoeten.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2025-08-23T15:59:37.000Z","updated_at":"2025-08-24T02:25:36.000Z","dependencies_parsed_at":"2025-08-24T11:20:57.927Z","dependency_job_id":"4eaedd49-3db6-49ac-82b8-a0dd4feec482","html_url":"https://github.com/remcostoeten/hono-analytics","commit_stats":null,"previous_names":["remcostoeten/hono-analytics"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/remcostoeten/hono-analytics","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remcostoeten%2Fhono-analytics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remcostoeten%2Fhono-analytics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remcostoeten%2Fhono-analytics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remcostoeten%2Fhono-analytics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/remcostoeten","download_url":"https://codeload.github.com/remcostoeten/hono-analytics/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remcostoeten%2Fhono-analytics/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273151416,"owners_count":25054410,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-01T02:00:09.058Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["analytics","edge-runtime","hono","privacy","self-hosted","typescript"],"created_at":"2025-09-01T16:04:25.627Z","updated_at":"2025-09-01T16:04:27.328Z","avatar_url":"https://github.com/remcostoeten.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HONO Analytics\n\nA self-hosted analytics solution built with HONO, TypeScript, and modern web technologies. Designed to be privacy-focused, lightweight, and developer-friendly.\n\n## Architecture\n\nThis is a monorepo containing:\n\n- **backend/**: HONO-based API server with Postgres/SQLite support\n- **sdk/**: TypeScript client SDK for web applications  \n- **example/**: Sample React app demonstrating SDK usage\n\n## Features\n\n- ✅ **User-centric analytics** (not event-centric)\n- ✅ **Session tracking** with 30-min inactivity timeout\n- ✅ **Developer traffic filtering** with automatic localhost detection\n- ✅ **Geographic data collection** with country/city tracking\n- ✅ **Device, browser, and OS detection** using user agent parsing\n- ✅ **UTM parameter tracking** for campaign attribution\n- ✅ **React provider + vanilla JS support** for all frameworks\n- ✅ **Privacy-focused** with user consent and data control\n- ✅ **Self-hosted** - your data stays on your servers\n- ✅ **TypeScript-first** with full type safety\n\n## Quick Start\n\n```bash\n# Clone and install\ngit clone https://github.com/your-org/hono-analytics.git\ncd hono-analytics\npnpm install\n\n# Start development environment (requires Docker for PostgreSQL)\n./dev.sh\n\n# Or use SQLite fallback\nDATABASE_URL=\"sqlite:./backend/analytics.db\" ./dev.sh\n```\n\nThis will start:\n- Backend API server on http://localhost:8000\n- Example React app on http://localhost:3000\n- PostgreSQL database (or SQLite if Docker unavailable)\n\n## Installation\n\n### Backend Setup\n\n1. **Environment Variables**\n   ```bash\n   cp .env.example .env\n   # Edit .env with your configuration\n   ```\n\n2. **Database Setup**\n   ```bash\n   # For PostgreSQL\n   docker-compose up -d postgres\n   \n   # For SQLite (no Docker required)\n   export DATABASE_URL=\"sqlite:./backend/analytics.db\"\n   ```\n\n3. **Run Migrations**\n   ```bash\n   cd backend\n   pnpm db:generate\n   pnpm db:migrate\n   ```\n\n4. **Start Backend**\n   ```bash\n   pnpm dev\n   ```\n\n### SDK Integration\n\n#### React/Next.js\n\n```tsx\nimport { AnalyticsProvider } from '@hono-analytics/sdk/react'\n\nexport function App() {\n  return (\n    \u003cAnalyticsProvider \n      apiKey=\"your-api-key\"\n      projectId=\"your-project-id\"\n      endpoint=\"https://your-analytics-api.com\"\n      debug={process.env.NODE_ENV === 'development'}\n    \u003e\n      \u003cYourApp /\u003e\n    \u003c/AnalyticsProvider\u003e\n  )\n}\n\n// In your components\nimport { useAnalytics } from '@hono-analytics/sdk/react'\n\nfunction MyComponent() {\n  const analytics = useAnalytics()\n  \n  const handleCustomEvent = async () =\u003e {\n    await analytics.track({\n      url: '/custom-action',\n      durationMs: 1000\n    })\n  }\n  \n  const handleIdentifyUser = () =\u003e {\n    analytics.identify({\n      id: 'user-123',\n      country: 'Netherlands',\n      city: 'Amsterdam'\n    })\n  }\n  \n  return (\n    \u003cbutton onClick={handleCustomEvent}\u003e\n      Track Custom Event\n    \u003c/button\u003e\n  )\n}\n```\n\n#### Vanilla JavaScript\n\n```js\nimport { initAnalytics, track, identify } from '@hono-analytics/sdk'\n\n// Initialize\nconst analytics = initAnalytics({\n  apiKey: 'your-api-key',\n  projectId: 'your-project-id',\n  endpoint: 'https://your-analytics-api.com'\n})\n\n// Track custom events\nawait track({\n  url: '/button-clicked',\n  durationMs: 500\n})\n\n// Identify users\nidentify({\n  id: 'user-123',\n  country: 'Netherlands'\n})\n```\n\n## Database Schema\n\n### Projects Table\n```sql\nCREATE TABLE projects (\n  id SERIAL PRIMARY KEY,\n  name TEXT NOT NULL,\n  api_key TEXT UNIQUE NOT NULL,\n  created_at TIMESTAMP DEFAULT NOW()\n);\n```\n\n### Users Table  \n```sql\nCREATE TABLE users (\n  id UUID PRIMARY KEY,\n  project_id INTEGER REFERENCES projects(id),\n  first_seen TIMESTAMP DEFAULT NOW(),\n  last_seen TIMESTAMP DEFAULT NOW(),\n  device TEXT,\n  browser TEXT,\n  os TEXT,\n  country TEXT,\n  city TEXT,\n  lat REAL,\n  lng REAL,\n  is_dev BOOLEAN DEFAULT FALSE\n);\n```\n\n### Sessions Table\n```sql\nCREATE TABLE sessions (\n  id UUID PRIMARY KEY,\n  user_id UUID REFERENCES users(id),\n  started_at TIMESTAMP DEFAULT NOW(),\n  ended_at TIMESTAMP,\n  referrer TEXT,\n  origin TEXT\n);\n```\n\n### Pageviews Table\n```sql\nCREATE TABLE pageviews (\n  id SERIAL PRIMARY KEY,\n  session_id UUID REFERENCES sessions(id),\n  url TEXT NOT NULL,\n  timestamp TIMESTAMP DEFAULT NOW(),\n  duration_ms INTEGER\n);\n```\n\n## API Reference\n\n### POST /track\n\nReceive analytics events from the SDK.\n\n**Headers:**\n- `x-api-key`: Your project API key\n- `x-dev-traffic`: \"true\" to mark as developer traffic (optional)\n- `Content-Type: application/json`\n\n**Request Body:**\n```json\n{\n  \"user\": {\n    \"id\": \"user-uuid\",\n    \"device\": \"desktop\",\n    \"browser\": \"Chrome 120\",\n    \"os\": \"macOS 14\",\n    \"country\": \"Netherlands\",\n    \"city\": \"Amsterdam\",\n    \"lat\": 52.3676,\n    \"lng\": 4.9041\n  },\n  \"session\": {\n    \"id\": \"session-uuid\",\n    \"referrer\": \"https://google.com\",\n    \"origin\": \"google\"\n  },\n  \"pageview\": {\n    \"url\": \"https://example.com/page\",\n    \"timestamp\": \"2024-01-01T00:00:00.000Z\",\n    \"durationMs\": 5000\n  }\n}\n```\n\n**Response:**\n- `204 No Content` on success\n- `401 Unauthorized` for invalid API key\n- `400 Bad Request` for malformed data\n\n### GET /metrics\n\nRetrieve aggregated analytics data.\n\n**Headers:**\n- `x-api-key`: Your project API key\n\n**Query Parameters:**\n- `range`: Time range (e.g., \"7d\", \"30d\", \"1y\") - defaults to \"7d\"\n- `exclude_dev`: \"true\" to exclude developer traffic - defaults to \"true\"\n\n**Response:**\n```json\n{\n  \"totals\": {\n    \"users\": 1250,\n    \"sessions\": 2100,\n    \"pageviews\": 5780,\n    \"avgDuration\": 2340\n  },\n  \"timeseries\": [\n    {\n      \"date\": \"2024-01-01\",\n      \"users\": 45,\n      \"sessions\": 67,\n      \"pageviews\": 142\n    }\n  ],\n  \"breakdowns\": {\n    \"topPages\": [\n      {\n        \"url\": \"/\",\n        \"views\": 890,\n        \"avgDuration\": 3200\n      }\n    ],\n    \"countries\": [\n      {\n        \"country\": \"Netherlands\",\n        \"users\": 456\n      }\n    ],\n    \"browsers\": [\n      {\n        \"browser\": \"Chrome 120\",\n        \"users\": 678\n      }\n    ],\n    \"devices\": [\n      {\n        \"device\": \"desktop\",\n        \"users\": 789\n      }\n    ]\n  }\n}\n```\n\n## SDK Configuration\n\n### AnalyticsOptions\n\n```typescript\ntype TAnalyticsOptions = {\n  apiKey: string              // Your project API key\n  projectId: string           // Your project ID\n  endpoint?: string           // API endpoint (default: http://localhost:8000)\n  ignoreAnalytics?: boolean   // Disable tracking entirely\n  debug?: boolean             // Enable debug logging\n}\n```\n\n### React Provider Props\n\n```typescript\ntype TProps = {\n  children: ReactNode\n  apiKey: string\n  projectId: string  \n  endpoint?: string\n  ignoreAnalytics?: boolean\n  debug?: boolean\n}\n```\n\n## Development\n\n### Prerequisites\n\n- Node.js 18+ \n- pnpm 8+\n- Docker (optional, for PostgreSQL)\n\n### Project Structure\n\n```\nhono-analytics/\n├── backend/           # HONO API server\n│   ├── src/\n│   │   ├── db/        # Database schema and client\n│   │   ├── routes/    # API route handlers\n│   │   ├── utils/     # Helper functions\n│   │   └── server.ts  # Main server entry\n│   └── package.json\n├── sdk/               # TypeScript SDK\n│   ├── src/\n│   │   ├── core/      # Core analytics functionality\n│   │   ├── react/     # React-specific exports\n│   │   └── index.ts   # Main SDK entry\n│   └── package.json\n├── example/           # Example React app\n└── dev.sh            # Development script\n```\n\n### Development Workflow\n\n1. **Start Development Environment**\n   ```bash\n   ./dev.sh\n   ```\n\n2. **Make Changes**\n   - Backend changes auto-restart the server\n   - SDK changes auto-rebuild and update example app\n   - Example app has hot-reload enabled\n\n3. **Test Changes**\n   - Visit http://localhost:3000 for the example app\n   - Check http://localhost:8000/health for backend status\n   - Monitor console for SDK debug logs\n\n### Environment Variables\n\nSee `.env.example` for all available environment variables.\n\n**Backend:**\n- `DATABASE_URL`: PostgreSQL or SQLite connection string\n- `DEFAULT_API_KEY`: Default API key for development\n- `PORT`: Server port (default: 8000)\n- `NODE_ENV`: Environment (development/production)\n\n**Example App:**\n- `VITE_ANALYTICS_API_KEY`: Analytics API key\n- `VITE_ANALYTICS_PROJECT_ID`: Project identifier\n- `VITE_ANALYTICS_ENDPOINT`: API endpoint URL\n\n## Deployment\n\n### Backend Deployment\n\n1. **Environment Setup**\n   ```bash\n   export DATABASE_URL=\"postgresql://user:pass@host:5432/analytics\"\n   export DEFAULT_API_KEY=\"your-production-key\"\n   export NODE_ENV=\"production\"\n   ```\n\n2. **Build and Start**\n   ```bash\n   cd backend\n   pnpm build\n   pnpm db:migrate\n   pnpm start\n   ```\n\n### Docker Deployment\n\n```dockerfile\nFROM node:18-alpine\nWORKDIR /app\nCOPY backend/package.json backend/pnpm-lock.yaml ./\nRUN npm install -g pnpm \u0026\u0026 pnpm install --frozen-lockfile\nCOPY backend/ .\nRUN pnpm build\nEXPOSE 8000\nCMD [\"pnpm\", \"start\"]\n```\n\n### Vercel/Netlify Edge Functions\n\nThe HONO backend is compatible with edge runtime environments:\n\n```typescript\n// api/analytics.ts\nimport { app } from '../backend/src/server'\n\nexport default app\n```\n\n## Privacy \u0026 GDPR\n\n- **User Consent**: SDK respects `ignoreAnalytics` flag\n- **Data Minimization**: Only collect necessary analytics data\n- **User Control**: Users can request data deletion via API\n- **No Cookies**: Uses localStorage with cookie fallback\n- **IP Anonymization**: Consider implementing IP hashing\n\n## Contributing\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md) for development guidelines.\n\n## License\n\nMIT - see [LICENSE](./LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremcostoeten%2Fhono-analytics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fremcostoeten%2Fhono-analytics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremcostoeten%2Fhono-analytics/lists"}