ember-cli-uncharted-describe-models

UnchartedCode Describe Models

==============================================================================

Please note, this is mainly used internally at the moment. We are making certain decisions based on our needs. If you would like to use this in your application then open an issue with your use case.

Generating ember-data schema from a backend definition. Meant to be used with the ember-schema gem.

Compatibility

• Ember.js v2.18 or above
• Ember CLI v2.13 or above
• Node.js v8 or above

Installation

ember install ember-cli-uncharted-describe-models

Usage

Users: If you are using this library I'd love to hear from you. This project is used "internally" for several projects and the direction is currently driven by those. We'd be happy to see others using it as well.

There are two main pieces to this library.

1. Automatically building model schema using a backend definition
2. Extending DS.Model with some helpful mixins

Automatically Defined Models

For the first part it is assumed that you generate a model for every backend model. However it's not necessary to define each field. What you need before any of this is a schema.json. It can be generated via the command line.

ember update-models --proxy http://localhost:5000

This assumes you have exposed /api/models/describe through the ember-schema gem. It will write out app/schema.json.

Once you have that you can generate a model which will automatically pull field level and associations from the schema.

ember generate model User

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.