{"id":39935449,"url":"https://github.com/peerigon/telemetrydeck-vue","last_synced_at":"2026-01-18T18:34:43.608Z","repository":{"id":248166575,"uuid":"827950879","full_name":"peerigon/telemetrydeck-vue","owner":"peerigon","description":"A library for using TelemetryDeck in your Vue 3 app","archived":false,"fork":false,"pushed_at":"2024-07-30T13:02:26.000Z","size":169,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-07-31T10:39:41.880Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/peerigon.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2024-07-12T18:29:59.000Z","updated_at":"2024-07-30T17:40:21.000Z","dependencies_parsed_at":"2024-07-30T10:37:54.528Z","dependency_job_id":"98e1a664-0cc0-4403-a2a0-beefea69b74a","html_url":"https://github.com/peerigon/telemetrydeck-vue","commit_stats":null,"previous_names":["peerigon/telementrydeck-vue","peerigon/telemetrydeck-vue"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/peerigon/telemetrydeck-vue","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peerigon%2Ftelemetrydeck-vue","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peerigon%2Ftelemetrydeck-vue/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peerigon%2Ftelemetrydeck-vue/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peerigon%2Ftelemetrydeck-vue/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peerigon","download_url":"https://codeload.github.com/peerigon/telemetrydeck-vue/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peerigon%2Ftelemetrydeck-vue/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28547292,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T14:59:57.589Z","status":"ssl_error","status_checked_at":"2026-01-18T14:59:46.540Z","response_time":98,"last_error":"SSL_read: 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":[],"created_at":"2026-01-18T18:34:42.944Z","updated_at":"2026-01-18T18:34:43.590Z","avatar_url":"https://github.com/peerigon.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# telemetrydeck-vue\n\nA library for using TelemetryDeck in your React app.\n\n[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)\n\n[![Test and 🚀 Release](https://github.com/peerigon/telemetrydeck-vue/actions/workflows/test_and_release.yml/badge.svg)](https://github.com/peerigon/telemetrydeck-vue/actions/workflows/test_and_release.yml)\n\n## Installation\n\n```shell\nnpm i @peerigon/telemetrydeck-vue --save\n```\n\n## Setup\n\nSet up the plugin in your application setup:\n\n```javascript\nimport TelemetryDeckPlugin from '@peerigon/telemetrydeck-vue';\n\nconst app = createApp(App);\napp.use(TelemetryDeckPlugin, {\n  appID: \"{your telemetrydeck appID}\",\n  testMode: true, // optional - defaults to false\n  clientUser: 'Guest' // optional - defaults to 'Guest'\n});\n\napp.mount('#app');\n```\n\n## Basic Usage\n\n```vue\n\u003cscript setup lang=\"ts\"\u003e\nimport { useTelemetryDeck } from \"@peerigon/telemetrydeck-vue\";\nconst { signal, queue, setClientUser } = useTelemetryDeck();\n\nconst changeClientUserClick = () =\u003e {\n  setClientUser('user' + Math.floor(Math.random() * 1000));\n};\n\nconst buttonSignalClick = () =\u003e {\n  signal('example_signal_event_name', {\n    custom_data: 'other_data', // any custom data as required\n  });\n};\n\nconst buttonQueueClick = () =\u003e {\n  queue('example_queue_event_name', {\n    custom_data: 'other_data', // any custom data as required\n  });\n};\n\nconst buttonSignalClickWithOptions = () =\u003e {\n  signal('example_signal_event_name_with_options', {\n    custom_data: 'other_data', // any custom data as required\n  }, {\n    testMode: true,\n    clientUser: 'other_user',\n    appID: 'other_app_id',\n  }); // telemetryDeck options (optional)\n};\n\nconst buttonQueueClickWithOptions = () =\u003e {\n  queue('example_queue_event_name_with_options', {\n    custom_data: 'other_data', // any custom data as required\n  }, {\n    testMode: true,\n    clientUser: 'other_user',\n    appID: 'other_app_id',\n  }); // telemetryDeck options (optional)\n};\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cdiv\u003e\n    \u003cdiv\u003e\n      \u003cbutton id=\"btnSignalClick\" @click=\"buttonSignalClick\"\u003eLog a click with signal\u003c/button\u003e\n      \u003cbutton id=\"btnQueueClick\" @click=\"buttonQueueClick\"\u003eLog a click with queue\u003c/button\u003e\n      \u003cbutton id=\"btnSetClient\" @click=\"changeClientUserClick\"\u003eChange user\u003c/button\u003e\n    \u003c/div\u003e\n    \u003cdiv\u003e\n      \u003cbutton id=\"btnSignalClickWithOptions\" @click=\"buttonSignalClickWithOptions\"\u003eLog a click with signal with Options\u003c/button\u003e\n      \u003cbutton id=\"btnQueueClickWithOptions\" @click=\"buttonQueueClickWithOptions\"\u003eLog a click with queue with Options\u003c/button\u003e\n    \u003c/div\u003e\n  \u003c/div\u003e\n\u003c/template\u003e\n```\n\n## Contributions\n\n### Local Development\n\nTo run the plugin locally for development:\n\n1. Install Node.js v20\n2. Run `npm i`\n3. create .env file from .env.example and add your test telemetryDeck appID. Create an account here: [telemetrydeck.com](https://telemetrydeck.com/)\n3. Run `npm run dev`\n4. Navigate to [http://localhost:5173/](http://localhost:5173/) for the test page\n\n### Tests\n\nRun the tests with:\n\n```shell\nnpm run test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeerigon%2Ftelemetrydeck-vue","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeerigon%2Ftelemetrydeck-vue","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeerigon%2Ftelemetrydeck-vue/lists"}