DEPRECATED, DO NOT USE THIS. Firefox Accounts relier JavaScript library
Перейти к файлу
Shane Tomlinson 2c65c1b5bf
Merge pull request #83 from Mozilla-GitHub-Standards/master r=@shane-tomlinson
Add Mozilla Code of Conduct
2019-04-01 22:47:13 +01:00
client fix(docs): Fix API example of fetching profile info 2015-12-02 15:32:25 +11:00
config Initial checkin of the lightbox API. 2014-11-19 15:37:37 +00:00
node chore(lint): add ESLint to repo 2015-06-29 11:15:26 -07:00
tasks chore(lint): add ESLint to repo 2015-06-29 11:15:26 -07:00
tests feat(auth): add a bestChoice option that omits the action parameter 2015-04-29 12:04:06 -04:00
.bowerrc Initial checkin of the lightbox API. 2014-11-19 15:37:37 +00:00
.eslintrc chore(lint): add ESLint to repo 2015-06-29 11:15:26 -07:00
.gitignore Set up for travis tests. 2014-11-24 13:38:26 +00:00
.jscsrc Initial checkin of the lightbox API. 2014-11-19 15:37:37 +00:00
.travis.yml chore(travis): use npm 2 for travis 2015-09-01 16:18:21 -04:00
CHANGELOG.md Start of release 0.0.8 2015-03-06 14:49:36 -08:00
CODE_OF_CONDUCT.md Add Mozilla Code of Conduct file 2019-03-29 09:51:54 -07:00
CONTRIBUTING.md chore(docs): add contributing.md 2015-09-08 14:57:44 -04:00
Gruntfile.js chore(lint): add ESLint to repo 2015-06-29 11:15:26 -07:00
LICENSE Initial commit 2014-11-04 09:40:39 -08:00
README.md chore(docs): add deprecatation notice 2016-09-30 14:13:01 -04:00
bower.json Start of release 0.0.8 2015-03-06 14:49:36 -08:00
npm-shrinkwrap.json chore(lint): add ESLint to repo 2015-06-29 11:15:26 -07:00
package.json chore(lint): add ESLint to repo 2015-06-29 11:15:26 -07:00

README.md

fxa-relier-client Build Status

DEPRECATED - do not use this library for new projects ()

Client JS library for FxA reliers

Integration Prerequisites

An OAuth client id is needed. Go get one from the folks in the #fxa IRC channel on irc.mozilla.org.

Installation

bower

  1. Add an fxa-relier-client entry to the dependencies section of bower.json.
{
  ...
  "dependencies": {
    "fxa-relier-client": "https://github.com/mozilla/fxa-relier-client.git#<latest_version>"
  }
}

Roll your own from the repo

  1. Clone the https://github.com/mozilla/fxa-relier-client.git repo locally.
  2. Ensure grunt-cli is installed - npm install -g grunt-cli
  3. grunt build
  4. Copy ./build/fxa-relier-client.min.js to a location it can be served by your web server.

Include the script in your HTML

In your HTML, include a script tag pointing to fxa-relier-client.js

  <script src="<location_of_relier_library>/fxa-relier-client.min.js"></script>

API docs

API docs for the current released version of the library are available at http://mozilla.github.io/fxa-relier-client/. Docs for the development version can be generated with the grunt doc command.

Development Prerequisites

  • npm
  • Grunt (npm install -g grunt-cli)

Grunt Commands

Grunt is used to run common tasks to build, test, and run local servers.

Tasks can be run from the command line by typing grunt <task>.

TASK DESCRIPTION
build build production resources. See task source for more documentation
clean remove any built production resources.
dev watch for changes to source files, run unit tests on changes.
doc generate API docs from YUIDoc tags embedded in source.
lint run ESLint, JSONLint, and JSCS (code style checker) on client side and testing JavaScript.
test run local Intern tests.
release create a new release. creates a release branch with current code, creates a new tag, updates the CHANGELOG.md, pushes updates to GitHub.

License

MPL 2.0