From 49afe1bfedbbfd38043b3ec3230f33c048e92d5d Mon Sep 17 00:00:00 2001 From: Eike Cochu <eike@cochu.com> Date: Sat, 9 Jan 2016 23:18:03 +0100 Subject: [PATCH] updated ui readme --- vipra-ui/README.md | 52 ++++++++++++---------------------------------- 1 file changed, 13 insertions(+), 39 deletions(-) diff --git a/vipra-ui/README.md b/vipra-ui/README.md index b5cb0438..0a2e3896 100644 --- a/vipra-ui/README.md +++ b/vipra-ui/README.md @@ -1,53 +1,27 @@ -# Vipra-ui +# Vipra-UI -This README outlines the details of collaborating on this Ember application. -A short introduction of this app could easily go here. +This is the user interface of Vipra. It provides the front end application, served from a static webserver, and connects to the vipra-rest REST backend application. -## Prerequisites +## Development -You will need the following things properly installed on your computer. +To compile/debug, install dependencies. Vipra-UI was built using Ember.js with ember-cli, which requires nodejs >= 4.x, npm >= 2.x, and bower -* [Git](http://git-scm.com/) -* [Node.js](http://nodejs.org/) (with NPM) -* [Bower](http://bower.io/) -* [Ember CLI](http://www.ember-cli.com/) -* [PhantomJS](http://phantomjs.org/) +In the project root, run: -## Installation - -* `git clone <repository-url>` this repository -* change into the new directory * `npm install` * `bower install` -## Running / Development - -* `ember server` -* Visit your app at [http://localhost:4200](http://localhost:4200). - -### Code Generators - -Make use of the many generators for code, try `ember help generate` for more details - -### Running Tests - -* `ember test` -* `ember test --server` - -### Building +to install dependencies. Notice that bower dependencies are pinned to specific versions to work around a bug in Ember. -* `ember build` (development) -* `ember build --environment production` (production) +Serve a development server with: -### Deploying +* `ember s` -Specify what it takes to deploy your app. +### Common problems -## Further Reading / Useful Links +If ember throws errors about highcharts, remove highcharts from package.json and reinstall: -* [ember.js](http://emberjs.com/) -* [ember-cli](http://www.ember-cli.com/) -* Development Browser Extensions - * [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi) - * [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/) +* npm uninstall --save-dev ember-highcharts +* ember install ember-highcharts +it seems that ember install does more than just installing dependencies. \ No newline at end of file -- GitLab