{"id":51238911,"url":"https://github.com/raananw/uptimizr","last_synced_at":"2026-06-28T23:00:33.131Z","repository":{"id":366350309,"uuid":"1275175440","full_name":"RaananW/Uptimizr","owner":"RaananW","description":"Open-source, privacy-first analytics for 3D scenes — view-direction \u0026 click heatmaps, mesh interactions, performance, and session replay. Self-hosted, multi-engine.","archived":false,"fork":false,"pushed_at":"2026-06-28T20:01:13.000Z","size":9571,"stargazers_count":1,"open_issues_count":20,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-28T20:04:02.056Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.uptimizr.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RaananW.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","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-06-20T10:54:44.000Z","updated_at":"2026-06-28T19:54:02.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/RaananW/Uptimizr","commit_stats":null,"previous_names":["raananw/uptimizr"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/RaananW/Uptimizr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RaananW%2FUptimizr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RaananW%2FUptimizr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RaananW%2FUptimizr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RaananW%2FUptimizr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RaananW","download_url":"https://codeload.github.com/RaananW/Uptimizr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RaananW%2FUptimizr/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34906700,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-28T02:00:05.809Z","response_time":54,"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":[],"created_at":"2026-06-28T23:00:17.606Z","updated_at":"2026-06-28T23:00:33.121Z","avatar_url":"https://github.com/RaananW.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Uptimizr\n\n\u003e 3D scene analytics — like Google Analytics, but for 3D applications.\n\n[![npm @uptimizr/babylon](https://img.shields.io/npm/v/@uptimizr/babylon?label=%40uptimizr%2Fbabylon\u0026logo=npm\u0026color=cb3837)](https://www.npmjs.com/package/@uptimizr/babylon)\n[![npm @uptimizr/sdk-core](https://img.shields.io/npm/v/@uptimizr/sdk-core?label=%40uptimizr%2Fsdk-core\u0026logo=npm\u0026color=cb3837)](https://www.npmjs.com/package/@uptimizr/sdk-core)\n[![CI](https://github.com/RaananW/Uptimizr/actions/workflows/main.yml/badge.svg)](https://github.com/RaananW/Uptimizr/actions/workflows/main.yml)\n[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](./LICENSE)\n[![Docs](https://img.shields.io/badge/docs-uptimizr.com-2563eb)](https://uptimizr.com/docs/)\n\n**[Documentation](https://uptimizr.com/docs/) · [Quickstart](https://uptimizr.com/docs/quickstart/) · [Run the collector](https://uptimizr.com/docs/deploy/collector/)**\n\nUptimizr captures and visualizes how people actually use 3D scenes: where they\n**look** (view-direction heatmaps), where they **point and click** (2D + 3D raycast\nheatmaps), which **meshes** they interact with, how the scene **performs** (FPS, device/GPU,\nasset load times), and any **custom events** a developer wants to track. It can also\n**replay** an individual session inside the developer's own scene.\n\nGoogle Analytics is built for 2D HTML pages and custom events; it has no concept of a\ncamera, a view vector, or a mesh. Uptimizr fills that gap.\n\n## Self-hostable, open source\n\nUptimizr is an **open-source data-collector** — a self-hostable SDK + ingestion + dashboard,\nlicensed Apache-2.0. Run it on a single embedded DuckDB file with no external database service,\nor scale out to ClickHouse + Postgres when you need to.\n\n## Live demo\n\nTry it with **zero setup** at **[demo.uptimizr.com](https://demo.uptimizr.com)** — a fully\nin-browser test drive: the playground and dashboard run side-by-side, and the analytics database\nruns **on your device** via DuckDB-Wasm. No account, no server, nothing uploaded; closing the tab\nwipes everything. From source, run it with `pnpm dev:web` (demo on `http://localhost:4320`). See\n[oss/apps/demo](./oss/apps/demo/README.md).\n\n## Tech stack\n\n- **Monorepo:** pnpm workspaces + Turborepo · TypeScript everywhere\n- **Ingestion/query API:** Fastify ([ADR 0005](./docs/adr/0005-backend-framework.md))\n- **Dashboard:** Next.js + Tailwind\n- **Event store (default):** a single embedded **DuckDB** file holds events **and** metadata — no\n  external database service ([ADR 0020](./docs/adr/0020-open-core-storage-boundary.md))\n- **Event store (optional scale tier):** ClickHouse (events) + Postgres (metadata)\n  ([ADR 0002](./docs/adr/0002-database.md))\n- **First 3D connector:** Babylon.js (three.js connector also available)\n- **Privacy:** cookieless / GDPR-first by default ([ADR 0003](./docs/adr/0003-privacy-model.md))\n\n## Repository layout\n\n```\noss/        Open-source product (Apache-2.0)\n  apps/       collector-server (Fastify), dashboard (Next.js), demo (in-browser test drive)\n  packages/   schema, sdk-core, sdk-babylon, sdk-three, replay, db (DuckDB store + contracts)\nexamples/   babylon-playground, three-playground — demo scenes for end-to-end testing\ninfra/      docker-compose for the optional ClickHouse + Postgres scale engines\ndocs/       architecture, phase plans, and ADRs\n```\n\n## Getting started\n\nThere are two ways in, depending on whether you're **using** Uptimizr in your own app or **working on\nthe project** itself.\n\n### Use Uptimizr in your app (from npm — no clone)\n\n**You don't need this repo to use Uptimizr.** Install a connector from npm and run the collector\nstraight from npm:\n\n```bash\nnpm i @uptimizr/babylon                              # or @uptimizr/three, @uptimizr/r3f, …\nnpm create uptimizr@latest                           # scaffold a self-host (prompts to add the dashboard + a demo)\n# …or run the collector CLI directly:\nnpx -p @uptimizr/collector-server uptimizr init      # create the DuckDB store + a project + API key\nnpx -p @uptimizr/collector-server uptimizr serve     # ingestion + query API on http://localhost:4318\n```\n\nSee the [Quickstart](https://uptimizr.com/docs/quickstart/) and\n[Run the collector](https://uptimizr.com/docs/deploy/collector/) for the full guide.\n\n### Work on Uptimizr from source (contributors)\n\nThe commands above are all you need to _use_ Uptimizr. The rest of this section is for **contributing\nto the project itself** — clone the repo and run it from source. The open-source collector stores\neverything in a single DuckDB file, so running from source needs **no external database service**:\n\n```bash\npnpm install\npnpm build                       # turbo build across all packages\npnpm lint \u0026\u0026 pnpm typecheck \u0026\u0026 pnpm test\n\ncp .env.example .env             # DUCKDB_PATH defaults to ./data/uptimizr.duckdb\npnpm db:setup                    # create the DuckDB file + seed a project \u0026 API key\npnpm dev:collector               # Fastify ingestion + query API (COLLECTOR_STORE=duckdb)\npnpm dev:dashboard               # optional: the analytics dashboard\n```\n\n- **Back up** = copy the `.duckdb` file. **Reset** = delete it and re-run `pnpm db:setup`.\n- **Single-writer constraint:** DuckDB is embedded and single-writer — only one process may open\n  the file read-write at a time. Run a single collector per file. For multi-writer / horizontal\n  scale, use the optional ClickHouse + Postgres scale tier (via `infra/docker`)\n  ([ADR 0020](./docs/adr/0020-open-core-storage-boundary.md)).\n\nTo run the full stack locally and verify it end-to-end (collector, dashboard, Babylon\nplayground, replay), follow the [manual testing guide](./docs/manual-testing.md) and the\n`run-local-stack` skill. See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for conventions and house rules.\n\n## Documentation\n\n- [Manual testing guide](./docs/manual-testing.md)\n- [Architecture overview](./docs/architecture/overview.md)\n- [Phase plans](./docs/phases)\n- [Architecture Decision Records](./docs/adr)\n- [Contributing](./CONTRIBUTING.md)\n- [Agent guide (`AGENTS.md`)](./AGENTS.md)\n\n## License\n\nThe open-source product (`oss/`, `examples/`, `infra/`, `docs/`) is licensed under\n[Apache-2.0](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraananw%2Fuptimizr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraananw%2Fuptimizr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraananw%2Fuptimizr/lists"}