1.0.3 • Published 2 years ago

@benjaminnoufel/adonis-ally-42 v1.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Adonis Ally 42 Driver

NPM version

A 42 driver for AdonisJS Ally

Getting started

1. Install the package

Install the package from your command line.

npm install --save adonis-ally-42

or

yarn add adonis-ally-42

2. Configure the package

node ace configure adonis-ally-42

3. Validate environment variables

FORTY_TWO_CLIENT_ID: Env.schema.string(),
FORTY_TWO_CLIENT_SECRET: Env.schema.string(),

4. Add variables to your ally configuration

const allyConfig: AllyConfig = {
  // ... other drivers
  fortyTwo: {
    driver: 'fortyTwo',
    clientId: Env.get('FORTY_TWO_CLIENT_ID'),
    clientSecret: Env.get('FORTY_TWO_CLIENT_SECRET'),
    callbackUrl: 'http://localhost:3333/42/callback',
  },
}

Scopes

You can pass an array of scopes in your configuration, for example ['public']. You have a full list of scopes in the 42 Oauth documentation

How it works

You can learn more about AdonisJS Ally in the documentation. And learn about the implementation in the ally-driver-boilerplate repository.

Contributing

  1. Fork the repo
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'feat: Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT