Skip to content

Latest commit

 

History

History
81 lines (46 loc) · 2.71 KB

README_template_generator.md

File metadata and controls

81 lines (46 loc) · 2.71 KB

Kinde [technology name] generator

The generator for the Kinde [technology name] SDK.

PRs Welcome Kinde Docs Kinde Community

Overview

This generator creates an SDK in [technology name] that can authenticate to Kinde using the Authorization Code grant or the Authorization Code with PKCE grant via the OAuth 2.0 protocol. It can also access the Kinde Management API using the client credentials grant.

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.

<todo>

  • Include details here on any tools required to use this generator, e.g. Docker. If none exist, remove the section altogether. Note: This is different to developing on the generator - see the Development section.

</todo>

Initial set up

  1. Clone the repository to your machine:

    git clone [https url]

  2. Go into the project:

    cd [name-of-repo]

  3. Install the OpenAPI Generator tool:

    https://openapi-generator.tech/docs/installation

SDK generation

Run the following command to generate the SDK:

[insert cmd]

Note: The API specifications should always point to Kinde's hosted version: https://kinde.com/api/kinde-mgmt-api-specs.yaml. This is set via the -i option in the OpenAPI Generator CLI, for example:

openapi-generator-cli generate -i https://kinde.com/api/kinde-mgmt-api-specs.yaml

The SDK gets outputted to: [insert path], which you can enter via:

cd [insert path]

SDK documentation

[technology name] SDK

Development

<todo>

  • Include details here on how to develop on this SDK, i.e. contribute to it. E.g., how to get the code running, test locally, build processes, etc.

</todo>

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.