{"id":26891771,"url":"https://github.com/hyperse-io/track","last_synced_at":"2025-11-03T17:41:15.466Z","repository":{"id":246748922,"uuid":"822514816","full_name":"hyperse-io/track","owner":"hyperse-io","description":"A typed,  smart, scalable , powerful data collection engine ","archived":false,"fork":false,"pushed_at":"2024-09-14T12:21:27.000Z","size":16952,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-09-15T18:35:10.176Z","etag":null,"topics":["facebook-pixel-tracker","google-tracking","hyperse","klaviyo-tracker","pipeline","track","typed-collection-engine"],"latest_commit_sha":null,"homepage":"https://hyperse-io.github.io/track/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hyperse-io.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","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},"funding":{"github":["hyperse-net"]}},"created_at":"2024-07-01T09:47:58.000Z","updated_at":"2024-09-14T12:20:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"6d11af48-e297-458f-a49e-86bf081d6c6d","html_url":"https://github.com/hyperse-io/track","commit_stats":null,"previous_names":["hyperse-io/track"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperse-io%2Ftrack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperse-io%2Ftrack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperse-io%2Ftrack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperse-io%2Ftrack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyperse-io","download_url":"https://codeload.github.com/hyperse-io/track/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246552948,"owners_count":20795835,"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","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":["facebook-pixel-tracker","google-tracking","hyperse","klaviyo-tracker","pipeline","track","typed-collection-engine"],"created_at":"2025-03-31T22:41:35.949Z","updated_at":"2025-11-03T17:41:15.433Z","avatar_url":"https://github.com/hyperse-io.png","language":"TypeScript","funding_links":["https://github.com/sponsors/hyperse-net"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003cimg alt=\"logo\" width=\"196px\" src=\"https://raw.githubusercontent.com/hyperse-io/track/main/website/static/img/logo-readme.svg?sanitize=true\"/\u003e\n\u003ch1 align=\"center\"\u003ehyperse data tracker engine\u003c/h1\u003e\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca aria-label=\"Build\" href=\"https://github.com/hyperse-io/track/actions?query=workflow%3ACI\"\u003e\n    \u003cimg alt=\"build\" src=\"https://img.shields.io/github/actions/workflow/status/hyperse-io/track/ci-integrity.yml?branch=main\u0026label=ci\u0026logo=github\u0026style=flat-quare\u0026labelColor=000000\" /\u003e\n  \u003c/a\u003e\n  \u003ca aria-label=\"stable version\" href=\"https://www.npmjs.com/package/@hyperse/track\"\u003e\n    \u003cimg alt=\"stable version\" src=\"https://img.shields.io/npm/v/%40hyperse%2Ftrack?branch=main\u0026label=version\u0026logo=npm\u0026style=flat-quare\u0026labelColor=000000\" /\u003e\n  \u003c/a\u003e\n  \u003ca aria-label=\"Top language\" href=\"https://github.com/hyperse-io/track/search?l=typescript\"\u003e\n    \u003cimg alt=\"GitHub top language\" src=\"https://img.shields.io/github/languages/top/hyperse-io/track?style=flat-square\u0026labelColor=000\u0026color=blue\"\u003e\n  \u003c/a\u003e\n  \u003ca aria-label=\"Licence\" href=\"https://github.com/hyperse-io/track/blob/main/LICENSE.md\"\u003e\n    \u003cimg alt=\"Licence\" src=\"https://img.shields.io/github/license/hyperse-io/track?style=flat-quare\u0026labelColor=000000\" /\u003e\n  \u003c/a\u003e\n  \u003ca aria-label=\"Discord\" href=\"https://www.hyperse.net/community\"\u003e\n    \u003cimg alt=\"Discord\" src=\"https://img.shields.io/discord/1249658585227460703?label=Discord\u0026color=5865F2\" /\u003e\n  \u003c/a\u003e\n  \u003ca aria-label=\"Twitter\" href=\"https://x.com/hyperse_net\"\u003e\n    \u003cimg alt=\"Twitter\" src=\"https://img.shields.io/badge/Twitter-black?logo=x\u0026logoColor=white\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cimg alt=\"uml\" src=\"https://raw.githubusercontent.com/hyperse-io/track/main/website/static/img/uml.svg\"/\u003e\n\n\u003c!-- hyperse-vitest-coverage-reporter-marker-readme --\u003e\n\n## Coverage Report\n\n\u003ctable\u003e \u003cthead\u003e \u003ctr\u003e \u003cth align=\"center\"\u003eStatus\u003c/th\u003e \u003cth align=\"left\"\u003eCategory\u003c/th\u003e \u003cth align=\"right\"\u003ePercentage\u003c/th\u003e \u003cth align=\"right\"\u003eCovered / Total\u003c/th\u003e \u003c/tr\u003e \u003c/thead\u003e \u003ctbody\u003e \u003ctr\u003e \u003ctd align=\"center\"\u003e🔵\u003c/td\u003e \u003ctd align=\"left\"\u003eLines\u003c/td\u003e \u003ctd align=\"right\"\u003e100%\u003c/td\u003e \u003ctd align=\"right\"\u003e191 / 191\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd align=\"center\"\u003e🔵\u003c/td\u003e \u003ctd align=\"left\"\u003eStatements\u003c/td\u003e \u003ctd align=\"right\"\u003e100%\u003c/td\u003e \u003ctd align=\"right\"\u003e191 / 191\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd align=\"center\"\u003e🔵\u003c/td\u003e \u003ctd align=\"left\"\u003eFunctions\u003c/td\u003e \u003ctd align=\"right\"\u003e98.21%\u003c/td\u003e \u003ctd align=\"right\"\u003e55 / 56\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd align=\"center\"\u003e🔵\u003c/td\u003e \u003ctd align=\"left\"\u003eBranches\u003c/td\u003e \u003ctd align=\"right\"\u003e93.02%\u003c/td\u003e \u003ctd align=\"right\"\u003e80 / 86\u003c/td\u003e \u003c/tr\u003e \u003c/tbody\u003e \u003c/table\u003e\n\n## Prerequisites\n\nBefore you begin, make sure you have the following installed:\n\n- Node.js (recommended version 16.x or higher)\n- npm (comes with Node.js)\n\n## Installation\n\n```ts\n// npm\nnpm i @hyperse/track\n\n// yarn\nyarn add @hyperse/track\n```\n\n## Development\n\n\u003e \\[!IMPORTANT]\n\u003e The following instructions are for those who want to develop the hyperse related framework or plugins (e.g. if you intend to make a pull request). For instructions on how to build a project _using_ Hyperse, please see the [Getting Started guide](https://hyperse-io.github.io/track/docs/community/contributing).\n\n### 1. Clone project to the local directory\n\n```bash\ngit clone https://github.com/hyperse-io/track.git\n```\n\n### 2. Install dependencies in the root directory\n\n```bash\nyarn install\n```\n\nor\n\n```bash\nnpm install\n```\n\nThe root directory has a `package.json` which contains build-related dependencies for tasks including:\n\n- Building \u0026 deploying the docs\n- Project for online presentation\n- Linting, formatting \u0026 testing tasks to run on git commit \u0026 push\n\n### 3. Testing\n\nMake sure to thoroughly test your changes before submitting them. This includes running unit tests, integration tests, and any other relevant testing methods to ensure code quality and functionality.\n\nThe core and several other packages have unit tests which are can be run all together by running `npm run test` from the root directory, or individually by running it from the package directory.\n\nUnit tests are co-located with the files which they test, and have the suffix `.spec.ts`.\n\n### 4. Improve documentation\n\nDocumentation is a critical part of any software project. To improve or update the documentation:\n\n1. Update Documentation Files: If your changes introduce new features, modify existing functionality, or fix bugs, update the relevant documentation files located in the /website directory.\n\n2. Build and Preview: Ensure that your documentation builds correctly and looks good by running:\n\n```bash\ncd website\n\nnpm run start\n```\n\n3. Commit Documentation Changes: Make sure all updates to documentation are committed alongside your code changes.\n\n### 5. Release Process\n\nTo make a release:\n\n1. Commit the Changes: Push your updated files to your branch.\n\n2. Create a Pull Request: [Open a pull request (PR)](https://github.com/hyperse-io/track/compare) with your changes. Make sure to include a clear description of what has been updated and why.\n\n3. GitHub Actions: Once the PR is merged into the main branch, the release process will be automatically handled by GitHub Actions. This includes tasks such as publishing to npm and updating documentation.\n\n## Documentation\n\nYou can find the Track documentation [on the website](https://hyperse-io.github.io/track/).\n\nCheck out the [Sample Example](https://hyperse-io.github.io/track/docs/intro/sample-example) page for a quick start.\n\n## License\n\nSee [LICENSE](https://github.com/hyperse-io/track/blob/main/LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperse-io%2Ftrack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperse-io%2Ftrack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperse-io%2Ftrack/lists"}