RETIRED, OpenStack Health Dashboard
Go to file
David Lyle c458d84097 Removing django code, not needed 2015-09-14 13:56:20 -06:00
app Remove example files 2015-09-11 17:31:45 -06:00
doc/source Convert README to rst, and add documentation template from cookiecutter 2015-08-03 10:15:34 -06:00
gulp Add `data` gulp task and automatically include `app/data` in dev builds if it exists. 2015-09-11 11:58:45 -06:00
test Add Angular boilerplate from `angularjs-gulp-browserify-boilerplate` 2015-08-31 15:18:45 -06:00
.coveragerc Add more test cookiecutter template items 2015-08-03 11:26:08 -06:00
.gitignore Add `data` gulp task and automatically include `app/data` in dev builds if it exists. 2015-09-11 11:58:45 -06:00
.jshintrc Add jshint configuration. 2015-09-02 15:49:18 -06:00
.testr.conf Add more test cookiecutter template items 2015-08-03 11:26:08 -06:00
CONTRIBUTING.rst Add more test cookiecutter template items 2015-08-03 11:26:08 -06:00
HACKING.rst Add .gitignore entries, HACKING.rst, and __init__.py contents from cookiecutter 2015-08-03 10:01:01 -06:00
LICENSE Add some missing base files from cookiecutter (LICENSE, manifest, setuptools config) 2015-08-03 09:11:51 -06:00
MANIFEST.in Include bower components during `setup.py install`, and use properly use relative static directory during export. 2015-08-13 14:45:09 -06:00
README.rst Use `gulp-replace` to rewrite JS and CSS paths during `gzip` task. `index.html.gz` now links properly to gzipped resources allowing them to be distributed alone and unmodified. 2015-09-09 17:13:40 -06:00
babel.cfg Add stub unit tests from cookiecutter 2015-08-03 10:37:55 -06:00
gulpfile.js Add Angular boilerplate from `angularjs-gulp-browserify-boilerplate` 2015-08-31 15:18:45 -06:00
manage.py Initial import containing a barebones django / browserify project 2015-07-13 15:55:45 -06:00
package.json Use `gulp-replace` to rewrite JS and CSS paths during `gzip` task. `index.html.gz` now links properly to gzipped resources allowing them to be distributed alone and unmodified. 2015-09-09 17:13:40 -06:00
requirements.txt Add dependencies to requirements.txt 2015-08-20 13:55:21 -06:00
setup.cfg Move export_static.py to export.py; add executable command definition to setup.cfg to install `stackviz-export` command during `setup.py install`. 2015-08-11 17:06:09 -06:00
setup.py Add some missing base files from cookiecutter (LICENSE, manifest, setuptools config) 2015-08-03 09:11:51 -06:00
test-requirements.txt Add stub unit tests from cookiecutter 2015-08-03 10:37:55 -06:00
tox.ini Add stub unit tests from cookiecutter 2015-08-03 10:37:55 -06:00

README.rst

StackViz: Angular

A temporary fork of StackViz while the conversion to Angular is in progress. Changes here will be merged back into the main StackViz repository when things have stabilized.

Installation

Installation of the frontend requires Node.js and Gulp. On Ubuntu:

sudo apt-get install nodejs npm nodejs-legacy
sudo npm install -g gulp

Then, install the Node modules by running, from the project directory:

npm install

Usage - Development

A development server can be run as follows:

gulp dev

This will open a web browser and reload code automatically as it changes on the filesystem.

Usage - Production

The production application can be build using:

gulp prod

The result will be written to ./build and should be appropriate for distribution. Note that all files are not required:

  • Directory structure (js/, css/, fonts/, images/): required.
  • Static resources (fonts/, images/): required.
  • Core files (index.html, js/main.js, css/main.css): required unless gzipped versions are used.
  • Gzipped versions of core files (*.gz): not required, but preferred. Use instead of plain core files to save on disk usage and bandwidth.
  • Source maps (js/main.js.map, js/main.js.map.gz): only required for debugging purposes.

Roadmap

  • Project split: All server-side components will be removed, and replaced with specialized data transformation tools.
    • Data sources and processing: moving to external project, potentially integrated directly with Testr and subunit2sql.
    • Web interface:
      • Will remain in this namespace (openstack-qa/stackviz).
      • Will decouple data processing from build process, allowing for distribution to nodes as a prebuilt static site.
      • Data sources will be configured in in a config.json.
      • Will support local and remote sources via REST/JSONP (pending API spec).
  • Angular conversion: current codebase will be rewritten to use Angular.
  • Python dependency removal: all Python depedencies and build requirements will be removed from this project.