README.md

Ember Flexberry Data

Ember Flexberry Data addon - Support of database projections, JavaScript Query Language, Offline data storage (IndexedDB via dexie) and working with several kinds of backends: OData V4, JSON API, etc.

Installation

• Latest release: ember install ember-flexberry-data
• Specific version: ember install [email protected]
• Latest commit from a branch: ember install flexberry/ember-flexberry-data#<BRANCH_NAME>
• Specific commit: ember install flexberry/ember-flexberry-data#<COMMIT_SHA>

Documentation

• Auto-generated under master branch: http://flexberry.github.io/master/modules/ember-flexberry-data.html
• Auto-generated under develop branch: http://flexberry.github.io/develop/modules/ember-flexberry-data.html

Collaborating / Development

Information on how to contribute to the project you can find here.

Prerequisites

You will need the following things properly installed on your computer.

• Git
• Node.js (with NPM)
• Ember CLI
• PhantomJS

Running

• ember serve
• Visit your app at http://localhost:4201.

Running Tests

• ember test – Runs the test suite on the current Ember version
• ember test --server – Runs the test suite in "watch mode"
• ember try:each – Runs the test suite against multiple Ember versions

If TEST_ODATA_SERVICE_URL variable is declared in environment of process then integration tests for OData service are also run (needs corresponding backend).

Linting

• yarn lint:js
• yarn lint:js --fix

Building

• ember build (development)
• ember build --environment production (production)

Releasing

• Merge develop branch with master branch
  • git checkout master
  • git merge --no-ff develop
  • git push
• ember release (for more information visit ember-cli-release)
  • To increment patch version run without specifying options.
  • To increment minor version run with --minor option.
  • To increment major version run with --major option.
• npm publish ./ (for more information visit How to publish packages to NPM)
• Merge master branch that contains additional commit for changing addon version with develop branch
  • git checkout develop
  • git merge --no-ff master
  • git push

Documenting

• Document your code using YUIDoc Syntax Reference. For examples, you can look at the documented code in the ember.js repository.
• After pushing into master or develop branch, documentation will be automatically generated and updated in Flexberry/Documentation repository, which is available via http://flexberry.github.io.
• For testing and generating documentation by hands use YUIDoc.

Further Reading / Useful Links

• ember.js
• ember-cli
• ember screencasts
• Development Browser Extensions
  • ember inspector for chrome
  • ember inspector for firefox

License

This project is licensed under the MIT License.