@bitkidd/adonis-ally-apple/README.md

An Apple driver for Adonis.js Ally

# Adonis Ally - Apple Sign In Driver

> adonis, adonis-ally, apple

[![npm-image]][npm-url] [![license-image]][license-url] [![typescript-image]][typescript-url]

This driver extends Adonis Ally and allows to integrate Apple Sign In.

## Installation

```bash
npm install @bitkidd/adonis-ally-apple
# or
yarn add @bitkidd/adonis-ally-apple
```

As the package has been installed, you have to configure it by running a command:

```bash
node ace configure @bitkidd/adonis-ally-apple
```

Then open the `env.ts` file and paste the following code inside the `Env.rules` object.

```ts
APPLE_APP_ID: Env.schema.string(),
APPLE_TEAM_ID: Env.schema.string(),
APPLE_CLIENT_ID: Env.schema.string(),
APPLE_CLIENT_SECRET: Env.schema.string(),
```

And don't forget to add these variables to your `.env` and `.env.sample` files.

## Usage

Apple Driver environment variables have some specific usage:

- `APPLE_CLIENT_SECRET` - your app private key that you should download from [here](https://developer.apple.com/account/resources/authkeys/list)
- `APPLE_CLIENT_ID` - the id of the key you downloaded earlier, it can be found on the same page
- `APPLE_TEAM_ID` - you teams' id in Apple system, it can be found [here](https://developer.apple.com/account/#/membership)
- `APPLE_APP_ID` - your app idenifier, for ex: com.adonis.ally

For usage examples for Adonis Ally and its methods consult Adonis.js [official docs](https://docs.adonisjs.com/guides/auth/social).

[npm-image]: https://img.shields.io/npm/v/@bitkidd/adonis-ally-apple.svg?style=for-the-badge&logo=npm
[npm-url]: https://npmjs.org/package/@bitkidd/adonis-ally-apple 'npm'
[license-image]: https://img.shields.io/npm/l/@bitkidd/adonis-ally-apple?color=blueviolet&style=for-the-badge
[license-url]: LICENSE.md 'license'
[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
[typescript-url]: "typescript"