Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bleacherreport/account_kit

API Client for Facebook's Account Kit
https://github.com/bleacherreport/account_kit

account-kit elixir facebook

Last synced: about 1 month ago
JSON representation

API Client for Facebook's Account Kit

Awesome Lists containing this project

README

        

# Account Kit
[![Hex pm](http://img.shields.io/hexpm/v/account_kit.svg?style=flat)](https://hex.pm/packages/account_kit)
[![Build Status](https://travis-ci.org/bleacherreport/account_kit.svg?branch=master)](https://travis-ci.org/bleacherreport/account_kit)
[![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://github.com/bleacherreport/plug_logger_json/blob/master/LICENSE)

An api client for Facebook Account Kit

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:

1. Add account_kit to your list of dependencies in `mix.exs`:

def deps do
[{:account_kit, "~> 0.1.0"}]
end

2. Ensure account_kit is started before your application:

def application do
[applications: [:account_kit]]
end

## Required Configuration
You must supply the below credentials. You will receive a reminder error if they are missing.

You should add the below snippet to config/config.exs or an environment specific config file
if you are using multiple facebook developer accounts for environments.

config :account_kit,
api_version: "v1.0",
app_id: "valid_app_id",
app_secret: "valid_app_secret",
require_appsecret: true

## Recommended Testing Setup
First setup acccount kit in your facebook developer account.

Next install a web client to test with:
* `git clone https://github.com/santiblanko/Account-kit-sample-for-web`
* `cd Account-kit-sample-for-web`
* Modify the JS login callback to log the auth code to console instead of into an html element (I get an error if an HTML element is used).
* `python -m SimpleHTTPServer 9000`
* Have chrome console open and preserving logs
* Fill out the email or phone form to test either flow.
* Check the chrome console for the auth code
* You can then use the auth code with the api calls available in this client

## Example API
Coming Soon

## Contributing
Before submitting your pull request, please run:
* `mix credo --strict`
* `mix coveralls`
* `mix dialyzer`

Please squash your pull request's commits into a single commit with a message and
detailed description explaining the commit.