https://github.com/x42en/livetoken-ui

Easily implement token authentication (unique and temporary code) in your meteor project.
https://github.com/x42en/livetoken-ui

Last synced: 2 months ago
JSON representation

Easily implement token authentication (unique and temporary code) in your meteor project.

• Host: GitHub
• URL: https://github.com/x42en/livetoken-ui
• Owner: x42en
• License: mit
• Created: 2016-03-21T10:25:41.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-03-21T14:01:38.000Z (about 9 years ago)
• Last Synced: 2025-01-30T09:43:00.960Z (4 months ago)
• Language: CoffeeScript
• Size: 12.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LiveToken-Ui

![Meteor Icon](http://icon.meteor.com/package/benmz:livetoken-ui)

[![Build Status](https://secure.travis-ci.org/x62en/livetoken-ui.png?branch=master)](https://travis-ci.org/x62en/livetoken-ui)

Easily implement token authentication (unique and temporary code) in your meteor project.

This is the user interface package, you could also check: livetoken-base wich will give you access to standard methods in order to make your own interface.

## Registration

First register yourself on [livetoken.io](http://livetoken.io) (it's free !) and retrieve your API Key (client_id) from your administration space.

___

## Install

Install with meteor:

  ```sh

    meteor add accounts-base

    meteor add benmz:livetoken-ui

  ```

## Configuration and usage

Configure on server side (replace the xxxxx with your client API Key):

  ```coffeescript

    if Meteor.isServer

      Meteor.startup () ->

        configLiveToken

         auth: 'EMAIL-ONLY'

         client_id: 'xxxxxxxxxxxxxxxxxxx'

  ```

Use it in your code (exemple below use):

  ```jade

    +loginLiveToken

  ```

___

## Configuration options

>There's different options available in order to configure your authentication method.

>These options must be set on server-side to Accounts.livetoken object

**auth**: Define the authentication method.

>Valid options are: EMAIL-ONLY / PHONE-ONLY / EMAIL-OR-PHONE / EMAIL-AND-PHONE

**client_id**: Define your client API key fo livetoken.io

**retry**: Define the max number of attempts your client can try token code before it gets invalidated

> default: 3

**timeout**: Define the max number of seconds before a token is invalidated

> default: 300