Changes for the node/js split
This commit is contained in:
parent
5420f8ce37
commit
543379d7e4
|
@ -8,7 +8,7 @@ steps:
|
|||
commands:
|
||||
- git clone https://git.odit.services/lfk/backend backend
|
||||
- cd backend
|
||||
- git checkout feature/31-lib_generation
|
||||
- git checkout dev
|
||||
- name: run openapi export
|
||||
image: node:alpine
|
||||
commands:
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
# ODIT.Services - LfK-Client
|
||||
# ODIT.Services - LfK-Client (Node 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)
|
||||
|
||||
|
@ -9,7 +9,7 @@ Get's automagicly™ build by drone for every new backend release.
|
|||
|
||||
Basic example: Get all tracks
|
||||
```typescript
|
||||
import {OpenAPI, TrackService} from "@odit/lfk-client";
|
||||
import {OpenAPI, TrackService} from "@odit/lfk-client-node";
|
||||
OpenAPI.BASE = "https://localhost:4010";
|
||||
console.log(await TrackService.trackControllerGetAll());
|
||||
```
|
||||
|
@ -18,9 +18,9 @@ console.log(await TrackService.trackControllerGetAll());
|
|||
|
||||
Via yarn/npm:
|
||||
```bash
|
||||
yarn add @odit/lfk-client
|
||||
yarn add @odit/lfk-client-node
|
||||
# Or
|
||||
npm i @odit/lfk-client
|
||||
npm i @odit/lfk-client-node
|
||||
```
|
||||
|
||||
Or just copy the folder `dist` to your prefered lib folder and import everything you need from `dist/index.ts`.
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@odit/lfk-client",
|
||||
"description": "A lib to interact with https://git.odit.services/lfk/backend",
|
||||
"name": "@odit/lfk-client-node",
|
||||
"description": "A lib to interact with https://git.odit.services/lfk/backend. Use this version for NodeJS applications.",
|
||||
"version": "0.0.3",
|
||||
"license": "CC-BY-NC-SA-4.0",
|
||||
"main": "./dist/index.js",
|
||||
|
@ -27,9 +27,9 @@
|
|||
"build:cleanup": "rimraf ./lib"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://git.odit.services/lfk/lib/issues"
|
||||
"url": "https://git.odit.services/lfk/lfk-client-node/issues"
|
||||
},
|
||||
"homepage": "https://git.odit.services/lfk/lib/",
|
||||
"homepage": "https://git.odit.services/lfk/lfk-client-node/",
|
||||
"devDependencies": {
|
||||
"@types/node": "^14.14.13",
|
||||
"@types/node-fetch": "^2.5.7",
|
||||
|
|
Reference in New Issue