lfk-client-js/README.md

26 lines
780 B
Markdown

# ODIT.Services - LfK-Client (JS Version)
The official library for the LfK [backend server](https://git.odit.services/lfk/backend).
Automagicly™ generated by [openapi-typescript-codegen](https://www.npmjs.com/package/openapi-typescript-codegen)
## 🛠 Building
Get's automagicly™ build by drone for every new backend release.
## Use
Basic example: Get all tracks
```typescript
import {OpenAPI, TrackService} from "@odit/lfk-client";
OpenAPI.BASE = "https://localhost:4010";
console.log(await TrackService.trackControllerGetAll());
```
### Install
Via yarn/npm:
```bash
yarn add @odit/lfk-client-js
# Or
npm i @odit/lfk-client-js
```
Or just copy the folder `dist` to your prefered lib folder and import everything you need from `dist/index.ts`.