neerajp99 / social_auth_foursquare Goto Github PK

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * How it works
 * Support requests
 * Maintainers

INTRODUCTION
------------

Social Auth Foursquare is a Foursquare authentication integration for Drupal. It is
based on the Social Auth and Social API projects

It adds to the site:
 * A new url: /user/login/foursquare.
 * A settings form on /admin/config/social-api/social-auth/foursquare page.
 * A foursquare Logo in the Social Auth Login block.

REQUIREMENTS
------------

This module requires the following modules:

 * Social Auth (https://drupal.org/project/social_auth)
 * Social API (https://drupal.org/project/social_api)

INSTALLATION
------------

 * Run composer to install the dependencies.
   composer require "drupal/social_auth_foursquare:^2.0""

 * Install the dependencies: Social API and Social Auth.

 * Install as you would normally install a contributed Drupal module. See:
   https://drupal.org/documentation/install/modules-themes/modules-8
   for further information.

 * A more comprehensive installation instruction for Drupal 8 can be found at
   https://www.drupal.org/node/2923804/

CONFIGURATION
-------------

 * Add your Foursquare project OAuth information in
   Configuration » User Authentication » Foursquare.

 * Place a Social Auth Foursquare block in Structure » Block Layout.

 * If you already have a Social Auth Login block in the site, rebuild the cache.


HOW IT WORKS
------------

User can click on the Foursquare logo on the Social Auth Login block
You can also add a button or link anywhere on the site that points
to /user/login/foursquare, so theming and customizing the button or link
is very flexible.

After Foursquare has returned the user to your site, the module compares the user id
or email address provided by Foursquare. If the user has previously registered using
Foursquare or your site already has an account with the same email address, the user
is logged in. If not, a new user account is created. Also, a Foursquare account can
be associated with an authenticated user.

SUPPORT REQUESTS
----------------

Before posting a support request, carefully read the installation
instructions provided in module documentation page.

Before posting a support request, check Recent log entries at
admin/reports/dblog

Once you have done this, you can post a support request at module issue queue:
https://www.drupal.org/project/issues/social_auth_foursquare

When posting a support request, please inform if you were able to see any errors
in Recent log entries.

MAINTAINERS
-----------

Current maintainers:
 *  Neeraj Pandey (neerajpandey) - https://www.drupal.org/u/neerajpandey