lfk/lfk-client-node
Archived
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Changes for the node/js split

Browse Source
This commit is contained in:
Nicolai Ort 2020-12-22 15:22:57 +01:00
parent 5420f8ce37
commit 543379d7e4
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.drone.yml
View File

@ -8,7 +8,7 @@ steps:
commands: commands:
- git clone https://git.odit.services/lfk/backend backend - git clone https://git.odit.services/lfk/backend backend
- cd backend - cd backend
- git checkout feature/31-lib_generation - git checkout dev
- name: run openapi export - name: run openapi export
image: node:alpine image: node:alpine
commands: commands:

8
README.md
View File

@ -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). 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) 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 Basic example: Get all tracks
```typescript ```typescript
import {OpenAPI, TrackService} from "@odit/lfk-client"; import {OpenAPI, TrackService} from "@odit/lfk-client-node";
OpenAPI.BASE = "https://localhost:4010"; OpenAPI.BASE = "https://localhost:4010";
console.log(await TrackService.trackControllerGetAll()); console.log(await TrackService.trackControllerGetAll());
``` ```
@ -18,9 +18,9 @@ console.log(await TrackService.trackControllerGetAll());
Via yarn/npm: Via yarn/npm:
```bash ```bash
yarn add @odit/lfk-client yarn add @odit/lfk-client-node
# Or # 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`. Or just copy the folder `dist` to your prefered lib folder and import everything you need from `dist/index.ts`.

8
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "@odit/lfk-client", "name": "@odit/lfk-client-node",
"description": "A lib to interact with https://git.odit.services/lfk/backend", "description": "A lib to interact with https://git.odit.services/lfk/backend. Use this version for NodeJS applications.",
"version": "0.0.3", "version": "0.0.3",
"license": "CC-BY-NC-SA-4.0", "license": "CC-BY-NC-SA-4.0",
"main": "./dist/index.js", "main": "./dist/index.js",
@ -27,9 +27,9 @@
"build:cleanup": "rimraf ./lib" "build:cleanup": "rimraf ./lib"
}, },
"bugs": { "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": { "devDependencies": {
"@types/node": "^14.14.13", "@types/node": "^14.14.13",
"@types/node-fetch": "^2.5.7", "@types/node-fetch": "^2.5.7",