/ember-jsonapi-resources

Lightweight persistence for an Ember CLI app following the JSON API 1.0 spec

Primary LanguageJavaScriptMIT LicenseMIT

Ember JSON API Resources

An Ember CLI Addon… a lightweight solution for data persistence in an Ember.js application following the JSON API 1.0 specification (your anti-bikeshedding weapon for API development).

See ember-jsonapi-resources.com

Build Status Ember Observer Score npm npm Gitter

Contributing / Development

Clone the repo, install the dependencies:

  • git clone this repository
  • npm install
  • bower install

Running

To run the app in /tests/dummy use a proxy url for a live API

  • ember server, an http-proxy is setup to use (dev) localhost:3000 or (prod) api.pixelhandler.com
  • Visit http://localhost:4200.

Running Tests

  • ember test
  • ember test --server
  • ember test --server -m 'Unit | Mixin | service cache'
  • ember test --server --filter 'cacheUpdate'

A good way to get to know more about how this addon works is to review the tests, see source code for the unit tests: tests/unit.

Building

  • ember build

For more information on using ember-cli, visit http://www.ember-cli.com/

Documentation

Online documentation, build from source: generated docs

Docs are generated from source using yuidoc.

To view the docs during development:

  • yuidoc ./addon/* -c yuidoc.json --server 3333 (you can append a port number e.g. --server 8888, the default port is 3000)

To generate docs for the gh-pages branch:

  • yuidoc ./addon/* -c yuidoc.json