Lightweight persistence for an Ember CLI app following the JSON API 1.0 spec
JavaScript HTML
Latest commit 9d6576a Jan 13, 2017 @pixelhandler 2.0.3
Permalink
Failed to load latest commit information.
addon Update rollback methods, not to behave like undo Jan 13, 2017
app Use ember-fetchjax and remove fetch mixin (#126) Nov 19, 2016
blueprints Change hasMany/hasOne to toMany/toOne (#124) Nov 18, 2016
config Update Ember and Ember CLI to v2.10.0 Dec 22, 2016
fixtures/api Relationship types from relatedproxy's metadata. (#96) Sep 6, 2016
lib Add fixture json, resources test helper, serializer unit tests Jun 8, 2015
node-tests/blueprints Fix broken model blueprint & add blueprint tests (#98) Sep 11, 2016
server Add http proxy server for testing dev/prod apis Dec 31, 2015
tests Update rollback methods, not to behave like undo Jan 13, 2017
vendor Initial Commit from Ember CLI v0.2.6 May 31, 2015
.bowerrc Initial Commit from Ember CLI v0.2.6 May 31, 2015
.editorconfig Upgrade to ember-cli v2.7.0 Jul 27, 2016
.ember-cli Initial Commit from Ember CLI v0.2.6 May 31, 2015
.gitignore Update Ember and Ember CLI to v2.10.0 Dec 22, 2016
.jshintrc Upgrade to ember-cli v2.7.0 Jul 27, 2016
.npmignore Fix broken model blueprint & add blueprint tests (#98) Sep 11, 2016
.travis.yml Update Ember and Ember CLI to v2.10.0 Dec 22, 2016
.watchmanconfig Upgrade to ember-cli 1.13.12 Nov 13, 2015
LICENSE.md Upgrade to ember-cli version: 2.3.0-beta.2 Feb 5, 2016
README.md Update Ember and Ember CLI to v2.10.0 Dec 22, 2016
bower.json Update Ember and Ember CLI to v2.10.0 Dec 22, 2016
ember-cli-build.js Upgrade to Ember CLI 2.5.0 & Ember 2.5.0 Apr 17, 2016
index.js Update es6-promise to v4.0.5 (#112) Oct 6, 2016
package.json 2.0.3 Jan 13, 2017
testem.js Upgrade to Ember CLI v2.4.1 Mar 4, 2016
yarn.lock Upgrade to Ember CLI v2.9.1 (#116) Oct 29, 2016
yuidoc.json Add yuidocjs for generation of docs from source code Jun 4, 2015

README.md

Ember JSON API Resources

A stand-alone data persistence solution as an addon for Ember.js applications built using Ember CLI. It follows the JSON API 1.0 specification (your anti-bikeshedding weapon for API development).

A thin data layer, a 1:1 solution using the JSON API spec, which does not attempt to solve "all the things".

By considering this equation e = mc2

“Errors = (More Code)2

…The "EJR" addon is a lightweight library that simply focuses on one solid specification, and follows common patterns for data persistence in Ember apps.

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'
  • npm run nodetest tests for blueprint, e.g. jsonapi-resource

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 https://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