RETIRED, Fuel Web UI

Go to file

Julia Aranovich 113b4277dd Add changing password warning to Change Password dialog Closes-Bug: #1555262 Change-Id: Icbbef6dfad859e3dd0856d73e77c3fb8621b1fd5		2016-04-20 13:15:30 +00:00
gulp	Forcing eslint max-len rule	2016-01-25 20:06:45 +03:00
specs	Add rpm spec file for fuel-ui	2016-03-01 12:14:18 +03:00
static	Add changing password warning to Change Password dialog	2016-04-20 13:15:30 +00:00
.eslintrc	Restore missing quote-props ESLint rule	2016-02-17 23:01:28 +07:00
.gitignore	Add necessary files	2016-03-01 14:55:40 +07:00
.gitreview	Add necessary files	2016-03-01 14:55:40 +07:00
LICENSE	Add necessary files	2016-03-01 14:55:40 +07:00
MAINTAINERS	Adds Nikolay Bogdanov to the maintainers list	2016-03-31 10:47:29 +00:00
README.rst	Update default FUEL_WEB_ROOT value for convenience	2016-03-01 15:35:50 +00:00
gulpfile.js	Update allowed licenses list	2016-03-17 19:06:16 +03:00
karma.config.js	Enable linting for node.js files and split .eslintrc	2016-01-17 18:01:55 +03:00
npm-shrinkwrap.json	Fix node-ip dependency declaration	2016-03-03 14:10:44 +07:00
package.json	Add a command to run nightly functional tests	2016-03-17 13:53:33 +03:00
run_ui_func_tests.sh	Don't move nailgun log for UI func tests manually	2016-03-14 15:14:27 +03:00
webpack.config.js	Colors refactoring	2016-03-01 13:42:50 +00:00

README.rst

FUEL UI

This repository contains Fuel UI - the web user interface for Nailgun.

Installation

Fuel UI requires Node.js 0.10+ to be installed on your system. On Ubuntu 14.04 you can install it using the following commands:

sudo apt-get remove --yes nodejs nodejs-legacy
sudo add-apt-repository --yes ppa:chris-lea/node.js
sudo apt-get update
sudo apt-get install --yes nodejs
sudo chown -R `whoami`.`whoami` ~/.npm

Install JS dependencies and Gulp:
```
npm install
sudo npm install -g gulp
```
The most convenient approach to modify Fuel UI is to use a development server. It watches for file changes and automatically rebuilds changed modules (significantly faster than full rebuild) and triggers page refresh in browsers:
```
gulp dev-server
```
By default it runs on port 8080 and assumes that Nailgun runs on port 8000. You can override this by using the following options:
```
gulp dev-server --dev-server-host=127.0.0.1 --dev-server-port=8080 --nailgun-host=127.0.0.1 --nailgun-port=8000
```
If automatic rebuild on change doesn't work, most likely you need to increase the limit of inotify watches:
```
echo 100000 | sudo tee /proc/sys/fs/inotify/max_user_watches
```
The production version of Fuel UI can be built by running:
```
gulp build
```
To specify custom output directory location, use static-dir option:
```
gulp build --static-dir=static_compressed
```
To speed up build process you may also want to disable uglification and source maps generation:
```
gulp build --no-uglify --no-sourcemaps
```
If for some reason you don't want to use a development server, but would like to recompile the bundle on any change, use:
```
gulp build --watch
```

Testing

UI tests use Selenium server, so you need to install Java Runtime Environment (JRE) 1.7 or newer version.
You also need to install Firefox - it is used as the default browser for tests.
Run full Web UI test suite, run:
```
npm run lint
npm test
```
UI functional tests require Nailgun server from fuel-web repo to be installed. By default it's assumed that fuel-web repo is in the same directory as fuel-ui repo, but you can specify another path using FUEL_WEB_ROOT environment variable:
```
FUEL_WEB_ROOT=/path/to/fuel-web npm test
```
By default Firefox browser is used. You can specify the browser using BROWSER environment variable:
```
BROWSER=chrome npm test
```