https://github.com/lookinlab/adonis-ally-vk

A driver of AdonisJS Ally for vk.com
https://github.com/lookinlab/adonis-ally-vk

adonis-ally adonis-ally-vk adonis-vk adonis-vkontakte adonisjs

Last synced: 3 months ago
JSON representation

A driver of AdonisJS Ally for vk.com

• Host: GitHub
• URL: https://github.com/lookinlab/adonis-ally-vk
• Owner: lookinlab
• License: mit
• Created: 2021-08-11T06:20:22.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-03-21T13:05:58.000Z (over 1 year ago)
• Last Synced: 2024-07-09T18:46:15.605Z (4 months ago)
• Topics: adonis-ally, adonis-ally-vk, adonis-vk, adonis-vkontakte, adonisjs
• Language: TypeScript
• Homepage:
• Size: 51.8 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-adonisjs - AdonisJS Ally Vk - A driver of AdonisJS Ally for vk.com (Packages)

README

        
# Adonis Ally Vk Driver

A driver of AdonisJS Ally for vk.com (vkontakte)

## Installation

Make sure to install it using `npm` or `yarn`.

```bash

# npm

npm i adonis-ally-vk

node ace configure adonis-ally-vk

# yarn

yarn add adonis-ally-vk

node ace configure adonis-ally-vk

```

Open a `instructions.md` file after configure

## Usage

Make sure to register the provider inside `.adonisrc.json` file.

```json

{

  "providers": [

    "...other packages",

    "adonis-ally-vk"

  ] 

}

```

For TypeScript projects add to `tsconfig.json` file:

```json

{

  "compilerOptions": {

    "types": [

      "...other packages",

      "adonis-ally-vk"

    ]

  } 

}

```

More about [AdonisJS Ally](https://docs.adonisjs.com/guides/auth/social) and as usage this driver

## An available configuration options

```ts

const allyConfig: AllyConfig = {

  // ... other drivers

  vk: {

    // ... config

    display: 'page',

    scopes: ['email', '...other'],

    fields: ['screen_name', 'bdate', '...other']

  },

}

```