Skip to content

bitkidd/adonis-ally-apple

Repository files navigation

Adonis Ally - Apple Sign In Driver

adonis, adonis-ally, apple

npm-image license-image typescript-image

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

Installation

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:

node ace configure @bitkidd/adonis-ally-apple

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

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
  • 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
  • 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.