Initial commit

onderay · web-flow · commit a23c787548cd · 2023-09-05T11:54:54.000+10:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,20 @@
+# http://editorconfig.org
+
+# ---------------------------------------------------------------------
+# DO NOT CHANGE THIS SECTION
+
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+# ---------------------------------------------------------------------
+# Add specific rules here… (Note: What you add can have an effect on Prettier)
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,11 @@
+# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+
+# ---------------------------------------------------------------------
+# DO NOT CHANGE THIS SECTION
+
+# These owners will be the default owners for everything in the repo. Unless a
+# later match takes precedence.
+* @daveordead @rairaman
+
+# ---------------------------------------------------------------------
+# Add specific owners here…
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,25 @@
+# https://git-scm.com/docs/gitignore
+
+# ---------------------------------------------------------------------
+# DO NOT CHANGE THIS SECTION
+
+# Dependencies
+node_modules/
+
+# Compiled output
+dist/
+build/
+coverage/
+
+# Generated at runtime
+*.log
+.cache
+
+# Personal files
+.idea
+
+# System files
+.DS_Store
+
+# ---------------------------------------------------------------------
+# Add specific rules here…
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,3 @@
+dist/
+build/
+coverage/
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,7 @@
+{
+  "singleQuote": true,
+  "trailingComma": "none",
+  "bracketSpacing": false,
+  "proseWrap": "never",
+  "overrides": []
+}
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "yzhang.markdown-all-in-one",
+    "editorconfig.editorconfig",
+    "esbenp.prettier-vscode"
+  ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,13 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.codeActionsOnSave": {"source.fixAll": true},
+  "editor.formatOnSave": true,
+  "files.trimTrailingWhitespace": true,
+  "markdown.extension.italic.indicator": "_",
+  "markdown.extension.toc.unorderedList.marker": "-",
+  "markdown.extension.toc.slugifyMode": "github",
+  "markdown.preview.fontFamily": "system-ui, -apple-system, sans-serif",
+  "files.associations": {
+    "CODEOWNERS": "ini"
+  }
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1 @@
+<!-- Ideally, this should get auto-generated via tools like [auto-changelog](https://github.com/CookPete/auto-changelog). Eventually, this will get set up as part of the repository template. -->
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Kinde
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,4 @@
+Please use one of these templates:
+
+- [README_template_non-generator.md](./README_template_non-generator.md)
+- [README_template_generator.md](./README_template_generator.md)
diff --git a/README_template_generator.md b/README_template_generator.md
@@ -0,0 +1,81 @@
+# Kinde [technology name] generator
+
+The generator for the [Kinde [technology name] SDK](<[link-to-sdk-repo](https://github.com/kinde-oss/kinde-auth-nextjs)>).
+
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) [![Kinde Docs](https://img.shields.io/badge/Kinde-Docs-eee?style=flat-square)](https://kinde.com/docs/developer-tools) [![Kinde Community](https://img.shields.io/badge/Kinde-Community-eee?style=flat-square)](https://thekindecommunity.slack.com)
+
+## 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](https://oauth.net/2/). It can also access the [Kinde Management API](https://kinde.com/api/docs/#kinde-management-api) using the client credentials grant.
+
+Also, see the SDKs section in Kinde’s [contributing guidelines](https://github.com/kinde-oss/.github/blob/main/.github/CONTRIBUTING.md).
+
+## 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:
+
+   ```bash
+   git clone [https url]
+   ```
+
+2. Go into the project:
+
+   ```bash
+   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:
+
+```bash
+[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](https://openapi-generator.tech/docs/usage/), for example:
+
+```bash
+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:
+
+```bash
+cd [insert path]
+```
+
+## SDK documentation
+
+[[technology name] SDK](<[link-to-kinde-doc](https://kinde.com/docs/developer-tools/)>)
+
+## 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](https://github.com/kinde-oss/.github/blob/489e2ca9c3307c2b2e098a885e22f2239116394a/CONTRIBUTING.md).
+
+## License
+
+By contributing to Kinde, you agree that your contributions will be licensed under its MIT License.
diff --git a/README_template_non-generator.md b/README_template_non-generator.md
@@ -0,0 +1,55 @@
+# Kinde [technology name]
+
+The Kinde SDK for [technology name].
+
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) [![Kinde Docs](https://img.shields.io/badge/Kinde-Docs-eee?style=flat-square)](https://kinde.com/docs/developer-tools) [![Kinde Community](https://img.shields.io/badge/Kinde-Community-eee?style=flat-square)](https://thekindecommunity.slack.com)
+
+## Development
+
+**`<todo>`**
+
+- [ ] Include details here on how to develop on this SDK, i.e. contribute to it. E.g., how to install the codebase, get the code running, test locally, build processes, etc. The "Initial set up" section has been added as a start. Please complete it and add to it if necessary.
+
+**`</todo>`**
+
+### Initial set up
+
+1. Clone the repository to your machine:
+
+   ```bash
+   git clone [https url]
+   ```
+
+2. Go into the project:
+
+   ```bash
+   cd [name-of-repo]
+   ```
+
+3. Install the dependencies:
+
+   ```bash
+   [the cmd]
+   ```
+
+## Documentation
+
+For details on integrating this SDK into your project, head over to the [Kinde docs](https://kinde.com/docs/) and see the [[technology name] SDK](<[link-to-kinde-doc](https://kinde.com/docs/developer-tools/)>) doc 👍🏼.
+
+## Publishing
+
+The core team handles publishing.
+
+**`<todo>`**
+
+- [ ] Include steps here on how to publish a new version of the SDK package. E.g., the GitHub Actions steps.
+
+**`</todo>`**
+
+## Contributing
+
+Please refer to Kinde’s [contributing guidelines](https://github.com/kinde-oss/.github/blob/489e2ca9c3307c2b2e098a885e22f2239116394a/CONTRIBUTING.md).
+
+## License
+
+By contributing to Kinde, you agree that your contributions will be licensed under its MIT License.
diff --git a/_NEW_REPO_CHECKLIST_.md b/_NEW_REPO_CHECKLIST_.md
@@ -0,0 +1,15 @@
+Once you've created a new repository, please complete the following checklist:
+
+- [ ] Complete the README (see instructions at the top of the file).
+- [ ] If needed for this repository’s technology or framework, add rules or overrides (to the marked section if present) to the following configuration files:
+  - [ ] `.editorconfig`
+  - [ ] `.prettierrc` (only add to the `overrides` array)
+  - [ ] `.prettierignore`
+  - [ ] `.gitignore`
+  - [ ] `.vscode/*.json`
+  - [ ] `.github/CODEOWNERS`
+- [ ] Add a linting configuration to this repository. E.g. if JavaScript-based, add [ESLint](https://eslint.org/docs/latest/use/getting-started). _Ideally, a lint task should run automatically on every commit to avoid being human linters in pull requests (see [lint-staged](https://github.com/okonet/lint-staged))._
+- [ ] Add the relevant package configuration file. E.g. if an npm package, add a [package.json](https://docs.npmjs.com/cli/v9/configuring-npm/package-json) file.
+- [ ] Add the relevant publishing pipeline and document it in the README (see instructions there). E.g. a [GitHub Action](https://github.com/features/actions) pipeline.
+- [ ] Refrain from adding [community health files](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file) to the `.github` folder (see the contributing guidelines [here](https://github.com/kinde-oss/.github/blob/02d19d8d2225444a29d2d2046a2726f7b17155fb/.github/CONTRIBUTING.md#community-health-files)).
+- [ ] Once the checklist is complete, delete this file.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<!-- Ideally, this should get auto-generated via tools like [auto-changelog](https://github.com/CookPete/auto-changelog). Eventually, this will get set up as part of the repository template. -->`