keycloak-typescript/README.md

A user friendly library to use keycloak in nodejs projects

<div align='center'>

<h1>Keycloak-Typescript</h1>
<p>A simple middleware library that simplifies the integration of keycloak with your project</p>

<h4> <span> · </span> <a href="https://github.com/Krasamo/keycloak-typescript/blob/master/docs/USAGE.md"> Documentation </a> <span> · </span> <a href="https://github.com/Krasamo/keycloak-typescript/issues"> Report Bug </a> <span> · </span> <a href="https://github.com/Krasamo/keycloak-typescript/issues"> Request Feature </a> </h4>


</div>

# :notebook_with_decorative_cover: Table of Contents

- [About the Project](#star2-about-the-project)
- [Contributing](#wave-contributing)
- [License](#warning-license)
- [Contact](#handshake-contact)
- [Acknowledgements](#gem-acknowledgements)


## :star2: About the Project
This project introduces a facade designed to simplify the data retrieval and transmission within the context of Keycloak. 
By offering unified methods for concrete actions, it mitigates the complexities associated with calling multiple endpoints of the Keycloak API for those actions.

## :toolbox: Getting Started

### :bangbang: Prerequisites

- Install Node JS in your computer<a href="https://nodejs.org/en/"> Here</a>


### :gear: Installation

In your Node JS project, run the following command to install the package
```bash
npm install keycloak-typescript
```


### :test_tube: Running Tests

To run tests, execute the following command
```bash
npm run test
```


### :running: Run Locally

Clone the project

```bash
https://github.com/krasamo/keycloak-typescript
```
Install dependencies
```bash
npm install
```
To generate a build
```bash
npm run build
```
To generate a package from the latest build for local testing
```bash
npm run pack
```


## :wave: Contributing

Contributions are always welcome!, if you want to contribute, create an issue (if it doesn't exists), fork this repo, and make a pull request when your changes are ready.

## :warning: License

Distributed under the MIT License. See LICENSE for more information.

## :handshake: Contact

Nestor Sandoval - - lloydna@krasamo.com

Project Link: [https://github.com/krasamo/keycloak-typescript](https://github.com/krasamo/keycloak-typescript)

## :gem: Acknowledgements

Frameworks, languages and tools used in this project:

- [Keycloak](https://www.keycloak.org/)
- [Axios](https://www.npmjs.com/package/axios)
- [Typescript](https://www.typescriptlang.org/)
- [query-string](https://www.npmjs.com/package/query-string)