README.md

Ember Flexberry

Ember Flexberry Addon - Flexberry ORM SPA UI Framework powered by Ember.js.

Installation or Upgrading

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

Documentation

• Common Flexberry PLATFORM documentation site: https://flexberry.github.io
• Auto-generated documentation under master branch: https://flexberry.github.io/master
• Auto-generated documentation under develop branch: https://flexberry.github.io/develop

Demo

Ember Flexberry comes with a dummy app that covers functionality of the addon.

• Stable version (master branch): http://flexberry.github.io/ember-flexberry/dummy/master/
• Bleeding edge version (develop branch): http://flexberry.github.io/ember-flexberry/dummy/develop/
• For temporal testing: http://flexberry.github.io/ember-flexberry/dummy/dummy-test/

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 (v10.*) (with NPM)
• Bower
• Ember CLI
• Google Chrome

Installation

• git clone <repository-url> this repository
• cd ember-flexberry
• yarn install
• bower install

Running Dummy Application

Ember Flexberry comes with a dummy app that covers functionality of the addon.

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

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

Linting

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

Linting

• npm run lint - run all linters
• npm run lint:js - run linter for code
• npm run lint:hbs - run linter for templates
• npx update-todo-errors - update list of todo errors

Building

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

Releasing

• Merge current release branch with master branch
  • git checkout master
  • git merge --no-ff <release-branch>
  • git push origin master
• 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 using current release branch as intermediary
  • git checkout <release-branch>
  • git merge --no-ff master
  • git push origin <release-branch>
  • git checkout develop
  • git merge --no-ff <release-branch>
  • git push origin develop
• Delete current release branch on GitHub

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 https://flexberry.github.io.
• For testing and generating documentation by hands use YUIDoc.

Further Reading / Useful Links

• ember.js
• ember-cli
• Development Browser Extensions
  • Ember Inspector for Chrome
  • Ember Inspector for Firefox

License

This project is licensed under the MIT License.