{"id":17617362,"url":"https://github.com/planbgmbh/flinkey-web-components","last_synced_at":"2025-04-30T18:12:14.356Z","repository":{"id":43727348,"uuid":"363144415","full_name":"PlanBGmbH/flinkey-web-components","owner":"PlanBGmbH","description":"This project provides some Web Components built for usage in combination with the flinkey API.","archived":false,"fork":false,"pushed_at":"2023-07-19T02:23:43.000Z","size":954,"stargazers_count":5,"open_issues_count":24,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-30T18:12:02.283Z","etag":null,"topics":["custom-elements","flinkey","flinkey-api","jest-tests","puppeteer","rest-api","stencil","tailwindcss","tsx","typescript","ui-components","web-components","witte-digital"],"latest_commit_sha":null,"homepage":"","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/PlanBGmbH.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2021-04-30T13:10:02.000Z","updated_at":"2022-07-21T11:53:02.000Z","dependencies_parsed_at":"2024-10-23T01:52:09.097Z","dependency_job_id":"44d53a5e-0901-4516-82d0-29a9678f1f11","html_url":"https://github.com/PlanBGmbH/flinkey-web-components","commit_stats":{"total_commits":301,"total_committers":7,"mean_commits":43.0,"dds":"0.18272425249169433","last_synced_commit":"53067b868b976f62ab4f4c1998afee13847b5304"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlanBGmbH%2Fflinkey-web-components","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlanBGmbH%2Fflinkey-web-components/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlanBGmbH%2Fflinkey-web-components/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PlanBGmbH%2Fflinkey-web-components/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PlanBGmbH","download_url":"https://codeload.github.com/PlanBGmbH/flinkey-web-components/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251758173,"owners_count":21638989,"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":["custom-elements","flinkey","flinkey-api","jest-tests","puppeteer","rest-api","stencil","tailwindcss","tsx","typescript","ui-components","web-components","witte-digital"],"created_at":"2024-10-22T19:12:53.196Z","updated_at":"2025-04-30T18:12:14.324Z","avatar_url":"https://github.com/PlanBGmbH.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# flinkey Web Components\n\n[![Build \u0026 Publish Package](https://github.com/PlanBGmbH/flinkey-web-components/actions/workflows/Build_Publish.yml/badge.svg)](https://github.com/PlanBGmbH/flinkey-web-components/actions/workflows/Build_Publish.yml) [![npm version](https://badge.fury.io/js/@planbgmbh%2Fflinkey-web-components.svg)](https://badge.fury.io/js/@planbgmbh%2Fflinkey-web-components) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)\n\n## Table of contents\n\n- [Introduction](#introduction)\n- [Getting started](#getting-started)\n- [Contributing](#contributing)\n- [Versioning](#versioning)\n\n## Introduction\n\nThis project provides some [Web Components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) built for usage in combination with the [flinkey API](https://developers.flinkey.com/api/v3/getting-started/). The reason to build these collection of [Web Components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) was that some functionality is provided via [flinkey API](https://developers.flinkey.com/api/v3/getting-started/) only but there is no pre-built UI for that functionality anywhere. Therefore each customer of WITTE Digital needs to build their own UI that consumes these specific endpoints.\n\n## Getting started\n\n### Installation\n\n```shell\nnpm install @planbgmbh/flinkey-web-components\n```\n\n### Usage example\n\n```ts\nGlobals.customerId = 1;\nGlobals.apiKey = 'SomeApiKey';\nGlobals.token = 'ey123';\nGlobals.apiBaseUrl = 'https://api.flinkey.de/v3';\n```\n\n```html\n\u003cflinkey-keyfob-catalog\u003e\u003c/flinkey-keyfob-catalog\u003e\n```\n\n## Contributing\n\nPlease read through our [contributing guidelines](./CONTRIBUTING.md).\n\n## Versioning\n\nMaintained under the [Semantic Versioning guidelines](https://semver.org/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplanbgmbh%2Fflinkey-web-components","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplanbgmbh%2Fflinkey-web-components","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplanbgmbh%2Fflinkey-web-components/lists"}