Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pixelhandler/ember-jsonapi-resources
Lightweight persistence for an Ember CLI app following the JSON API 1.0 spec
https://github.com/pixelhandler/ember-jsonapi-resources
data-persistence ember-addon json-api
Last synced: about 1 month ago
JSON representation
Lightweight persistence for an Ember CLI app following the JSON API 1.0 spec
- Host: GitHub
- URL: https://github.com/pixelhandler/ember-jsonapi-resources
- Owner: pixelhandler
- License: mit
- Created: 2015-05-31T23:43:54.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-11-25T19:44:27.000Z (about 7 years ago)
- Last Synced: 2024-11-09T17:46:24.487Z (about 2 months ago)
- Topics: data-persistence, ember-addon, json-api
- Language: JavaScript
- Homepage: https://pixelhandler.github.io/ember-jsonapi-resources/
- Size: 1.13 MB
- Stars: 124
- Watchers: 9
- Forks: 19
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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.
* [ember-jsonapi-resources] website
* [The Guide](https://pixelhandler.gitbooks.io/ember-jsonapi-resources-guide/content/)
* [API Docs][generated docs]
* [Example App]
* [Cookbooks / Wiki][Wiki Guide]
[](https://travis-ci.org/pixelhandler/ember-jsonapi-resources)
[](http://emberobserver.com/addons/ember-jsonapi-resources)
[](https://www.npmjs.com/package/ember-jsonapi-resources)
[](https://www.npmjs.com/package/ember-jsonapi-resources)
[](https://gitter.im/pixelhandler/ember-jsonapi-resources?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
## 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 .
### 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](tests/unit).
### Building
* `ember build`
For more information on using ember-cli, visit [https://www.ember-cli.com/][Ember CLI]
## 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`
[Ember CLI]: https://www.ember-cli.com/
[Ember.js]: http://emberjs.com
[ember-jsonapi-resources]: https://pixelhandler.github.io/ember-jsonapi-resources/
[Example App]: https://github.com/pixelhandler/jr-test
[generated docs]: http://pixelhandler.github.io/ember-jsonapi-resources/docs
[JSON API]: http://jsonapi.org
[Wiki Guide]: https://github.com/pixelhandler/ember-jsonapi-resources/wiki
[yuidoc]: https://github.com/yui/yuidoc