From c7f32747eaff942553644e022383dad02107aeb0 Mon Sep 17 00:00:00 2001 From: Igor Zhukov Date: Thu, 9 Apr 2015 14:09:56 +0300 Subject: [PATCH] Updated readme Added LESS rebuild workaround Closes #756 --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a93c428f..9d925d5d 100644 --- a/README.md +++ b/README.md @@ -53,19 +53,38 @@ The app is based on AngularJS JavaScript framework, written in pure JavaScript. ### Running locally +Project repository is based on angularjs-seed and includes gulp tasks, so it's easy to launch the app locally on your desktop. +Install [node.js](http://nodejs.org/) and run following commands in the project directory + +``` +sudo npm install -g gulp +sudo npm install +``` + +This will install all the needed dependencies. + + #### Running web-server -Project repository is based on angularjs-seed and includes a simple web-server, so it's easy to launch the app locally on your desktop. -Install [node.js](http://nodejs.org/) and run `node server.js`. Open page http://localhost:8000/app/index.html in your browser. + +Just run `gulp watch` task to start web server and livereload task. +Open page http://localhost:8000/app/index.html in your browser. + + #### Running as Chrome Packaged App To run this application in Google Chrome browser as a packaged app, open this URL in Chrome: `chrome://extensions/`, then tick "Developer mode" and press "Load unpacked extension...". Select the downloaded `app` folder and Webogram application should appear in the list. +Launch `gulp watch` command to watch for file changes and automatically rebuild the app. + + #### Running as Firefox OS App To run this application in Firefox as a packaged app, open "Menu" -> "Developer" -> "WebIDE" (or use `Shift + F8` shortcut). Choose "Open packaged app" from Project menu and select `app` folder. +Launch `gulp watch` command to watch for file changes and automatically rebuild the app. + ### Third party libraries