Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/planbgmbh/flinkey-web-components
This project provides some Web Components built for usage in combination with the flinkey API.
https://github.com/planbgmbh/flinkey-web-components
custom-elements flinkey flinkey-api jest-tests puppeteer rest-api stencil tailwindcss tsx typescript ui-components web-components witte-digital
Last synced: 4 months ago
JSON representation
This project provides some Web Components built for usage in combination with the flinkey API.
- Host: GitHub
- URL: https://github.com/planbgmbh/flinkey-web-components
- Owner: PlanBGmbH
- License: mit
- Created: 2021-04-30T13:10:02.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-19T02:23:43.000Z (over 1 year ago)
- Last Synced: 2024-09-23T15:18:03.236Z (5 months ago)
- Topics: custom-elements, flinkey, flinkey-api, jest-tests, puppeteer, rest-api, stencil, tailwindcss, tsx, typescript, ui-components, web-components, witte-digital
- Language: TypeScript
- Homepage:
- Size: 932 KB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# flinkey Web Components
[](https://github.com/PlanBGmbH/flinkey-web-components/actions/workflows/Build_Publish.yml) [](https://badge.fury.io/js/@planbgmbh%2Fflinkey-web-components) [](./LICENSE)
## Table of contents
- [Introduction](#introduction)
- [Getting started](#getting-started)
- [Contributing](#contributing)
- [Versioning](#versioning)## Introduction
This 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.
## Getting started
### Installation
```shell
npm install @planbgmbh/flinkey-web-components
```### Usage example
```ts
Globals.customerId = 1;
Globals.apiKey = 'SomeApiKey';
Globals.token = 'ey123';
Globals.apiBaseUrl = 'https://api.flinkey.de/v3';
``````html
```
## Contributing
Please read through our [contributing guidelines](./CONTRIBUTING.md).
## Versioning
Maintained under the [Semantic Versioning guidelines](https://semver.org/).