Pryv Javascript library for browsers & Node.js
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc-src
examples
scripts
source
test
.gitignore
.jshintignore
.jshintrc
Gruntfile.js
README.md
bower.json
package-lock.json
package.json
test-delete_me_please.PNG

README.md

Pryv library for Javascript

Javascript library (browser & Node.js) to access and manipulate Pryv users data.

NPM version Stories in Ready

Usage examples on CodePen

Pryv on CodePen

Installation

  • Browser: <script type="text/javascript" src="http://api.pryv.com/lib-javascript/latest/pryv.js"></script>
  • Node.js: npm install pryv

Docs

Contribute

See the issues on the Waffle board.

Dev environment setup

Read, then run ./scripts/setup-environment-dev.sh

Build and tests

grunt:

  • applies code linting (with JSHint)
  • builds documentation into dist/{version}/docs
  • browserifies the lib into dist/{version} as well as dist/latest for browser standalone distribution
  • runs the tests, outputting coverage info into test/coverage.html

Also: grunt test & grunt watch (runs tests on changes)

./scripts/update-event-types.bash updates the default event types and extras by fetching the latest master versions online.

Publish

After building, just commit and push changes from dist (working copy of gh-pages branch).

License

Revised BSD license