Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kleister/kleister-js

Kleister: SDK for Javascript
https://github.com/kleister/kleister-js

javascript kleister minecraft openapi sdk

Last synced: 8 days ago
JSON representation

Kleister: SDK for Javascript

Awesome Lists containing this project

README

        

# Kleister: SDK for Javascript

[![General Workflow](https://github.com/kleister/kleister-js/actions/workflows/general.yml/badge.svg)](https://github.com/kleister/kleister-js/actions/workflows/general.yml) [![Join the Matrix chat at https://matrix.to/#/#kleister:matrix.org](https://img.shields.io/badge/matrix-%23kleister%3Amatrix.org-7bc9a4.svg)](https://matrix.to/#/#kleister:matrix.org) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/10cbe4009f3043f8b0a5f89216049e1b)](https://app.codacy.com/gh/kleister/kleister-js/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![NPM Version](https://badge.fury.io/js/kleisterjs.svg)](https://badge.fury.io/js/kleisterjs)

This repository provides a client SDK for Typescript/Javascript. This SDK is
automatically generated by the [OpenAPI Generator][generator] project:

- API version: 1.0.0-alpha1
- Package version: 2.2.1
- Build package: org.openapitools.codegen.languages.TypeScriptAxiosClientCodegen

For more information, please visit [https://kleister.eu](https://kleister.eu)

## Environments

- Node.js
- Webpack
- Browserify

## Language level

- ES5 - you must have a Promises/A+ library installed
- ES6

## Module system

- CommonJS
- ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition
will be automatically resolved via `package.json`.

## Installation

### Installation with NPM

If you want to use one of the versions released via NPM you just need to execute
the following command within your project directory, after that you can import
it as other libraries:

```console
npm install --save [email protected]
```

### Installation with Git

If you want to use an unreleased version hosted on our GitHub repository you can
execute the folling command within your project directory, after that you can
import it as other libraries:

```console
npm install --save https://github.com/kleister/kleister-js
```

## Building

To build and compile the Typescript sources to Javascript simply execute the
following commands and you are ready to go:

```console
npm install
npm run build
```

## Security

If you find a security issue please contact
[[email protected]](mailto:[email protected]) first.

## Contributing

Fork -> Patch -> Push -> Pull Request

## Authors

- [Thomas Boerger](https://github.com/tboerger)

## License

Apache-2.0

## Copyright

```console
Copyright (c) 2018 Thomas Boerger
```

[generator]: https://openapi-generator.tech