Skip to content

Commit

Permalink
Update README.md (#871)
Browse files Browse the repository at this point in the history
  • Loading branch information
Bratchikov Igor authored and DubrovinPavel committed Oct 23, 2019
1 parent e5b206d commit 56e7ce9
Showing 1 changed file with 7 additions and 23 deletions.
30 changes: 7 additions & 23 deletions README.md
Expand Up @@ -19,17 +19,17 @@ Ember Flexberry Addon - [Flexberry ORM](http://flexberry.ru/) SPA UI Framework p

## Documentation

* Common Flexberry PLATFORM documentation site: http://flexberry.github.io
* Auto-generated documentation under `master` branch: http://flexberry.github.io/master
* Auto-generated documentation under `develop` branch: http://flexberry.github.io/develop
* 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](/tests/dummy) that covers functionality of the addon.

* Stable version (master branch): https://flexberry.github.io/ember-flexberry/dummy/master/
* Bleeding edge version (develop branch): https://flexberry.github.io/ember-flexberry/dummy/develop/
* For temporal testing: https://flexberry.github.io/ember-flexberry/dummy/dummy-test/
* 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

Expand Down Expand Up @@ -89,26 +89,10 @@ Ember Flexberry comes with a [dummy app](/tests/dummy) that covers functionality
* `git push origin develop`
* Delete current release branch on GitHub

#### Deploying Dummy Application

Automatic deployment on [Firebase](https://www.firebase.com):
* After a successful [Travis CI build](https://travis-ci.org/Flexberry/ember-flexberry), dummy app deploys on
* https://flexberry-ember.firebaseapp.com for master branch
* https://flexberry-ember-dev.firebaseapp.com for develop branch
* After update dummy-test branch, dummy app deploy on
* https://flexberry-ember-test.firebaseapp.com

Manual deployment on [Firebase](https://www.firebase.com):
* `npm install -g firebase-tools` (install [Firebase CLI](https://www.firebase.com/docs/hosting/command-line-tool.html))
* `ember build` (build application to `dist/` directory)
* Deploying:
* For owners, who have access to the https://ember-flexberry-test.firebaseio.com:</br>`firebase deploy` (deploy `dist/` directory on https://ember-flexberry-test.firebaseapp.com, as described in the [firebase.json](/firebase.json))
* For others:</br>`firebase deploy -f you-firebase-app` (deploy `dist/` directory on your own Firebase application)

#### Documenting

* Document your code using [YUIDoc Syntax Reference](http://yui.github.io/yuidoc/syntax/index.html). 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](https://github.com/Flexberry/flexberry.github.io), which is available via http://flexberry.github.io.
* After pushing into master or develop branch, documentation will be automatically generated and updated in [Flexberry/Documentation repository](https://github.com/Flexberry/flexberry.github.io), which is available via https://flexberry.github.io.
* For testing and generating documentation by hands use [YUIDoc](http://yui.github.io/yuidoc/).

## Further Reading / Useful Links
Expand Down

0 comments on commit 56e7ce9

Please sign in to comment.