Skip to content

Latest commit

 

History

History
70 lines (40 loc) · 2.55 KB

readme.md

File metadata and controls

70 lines (40 loc) · 2.55 KB

Kinde Android generator

The generator for the Kinde Android SDK.

PRs Welcome Kinde Docs Kinde Community

Overview

This generator creates an SDK in Kotlin that can authenticate to Kinde using the Authorization Code grant or the Authorization Code with PKCE grant via the OAuth 2.0 protocol.

Also, see the SDKs section in Kinde’s contributing guidelines.

Usage

Requirements

You will need the following tools to be able to generate the SDK.

OpenJDK

Generating the SDK will require OpenJDK to be installed, instructions for which can be found here. Please ensure that the JAVA_HOME environment variable is set and added to your PATH.

Initial set up

  1. Clone the repository to your machine:

    git clone https://github.com/kinde-oss/kinde-android-generator.git

  2. Go into the project:

    cd kinde-android-generator

SDK generation

Run the following command to generate the SDK:

./generate.sh

This generator does not require the OpenAPI Generator CLI tool since it uses gradlew and the OpenAPI Generator Gradle Plugin plugin to generate the SDK.

Note: The API specifications should always point to Kinde's hosted version: https://kinde.com/api/kinde-mgmt-api-specs.yaml. Please replace this file in the project root with that of the hosted version before generating the SDK.

The SDK gets outputted to: kinde-sdk, which you can enter via:

cd ./kinde-sdk

SDK documentation

Android SDK

Development

The instructions provided in the "Usage" section above are sufficient to get you started.

Contributing

Please refer to Kinde’s contributing guidelines.

License

By contributing to Kinde, you agree that your contributions will be licensed under its MIT License.