2c65c1b5bf
Add Mozilla Code of Conduct |
||
---|---|---|
client | ||
config | ||
node | ||
tasks | ||
tests | ||
.bowerrc | ||
.eslintrc | ||
.gitignore | ||
.jscsrc | ||
.travis.yml | ||
CHANGELOG.md | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
Gruntfile.js | ||
LICENSE | ||
README.md | ||
bower.json | ||
npm-shrinkwrap.json | ||
package.json |
README.md
fxa-relier-client
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
- Add an
fxa-relier-client
entry to thedependencies
section ofbower.json
.
{
...
"dependencies": {
"fxa-relier-client": "https://github.com/mozilla/fxa-relier-client.git#<latest_version>"
}
}
Roll your own from the repo
- Clone the https://github.com/mozilla/fxa-relier-client.git repo locally.
- Ensure
grunt-cli
is installed -npm install -g grunt-cli
grunt build
- 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