OpenStack Task Tracking Browser Client

Go to file

Michael Krotscheck 9db221c84f Removed nodeenv dependency Once #106152 lands, nodejs will be available on our trusty build nodes, so nodeenv is no longer strictly required. However, not everyone wants to install nodejs on their system, so we now wrap the nodeenv invocation into a script to test whether a local node exists. Since we can no longer assume the existence of a clean virtual environment, we also no longer install a global version of bower and grunt, and instead use the versions bundled with the codebase's package.json. Change-Id: I42f4b61037b8e988708b39e951dd2cddd99313b0		2014-08-12 17:02:07 -07:00
bin	Removed nodeenv dependency	2014-08-12 17:02:07 -07:00
src	Formalized Resource Criteria API	2014-08-11 07:43:54 -07:00
test	Formalized Resource Criteria API	2014-08-11 07:43:54 -07:00
.gitignore	Favicon Whitelabel	2014-04-24 10:59:05 -07:00
.gitreview	Initial commit	2014-01-14 18:49:39 -08:00
.jshintrc	Added unit tests for string_util.	2014-03-28 16:57:32 -07:00
bower.json	Added StoryBoard administration module.	2014-07-16 07:36:05 -07:00
Gruntfile.js	Fixed template inclusion for nested templates.	2014-07-18 16:23:26 -07:00
karma-integration.conf.js	Auth support	2014-03-03 13:56:11 -08:00
karma-unit.conf.js	Added unit tests for string_util.	2014-03-28 16:57:32 -07:00
LICENSE	Initial commit	2014-01-14 18:49:39 -08:00
package.json	Removed nodeenv dependency	2014-08-12 17:02:07 -07:00
protractor.conf.js	Fix NPM CA Chain issue and port conflict.	2014-02-28 14:04:01 -08:00
README.md	Documentation improvement	2014-06-16 13:59:23 +02:00
tox.ini	Removed nodeenv dependency	2014-08-12 17:02:07 -07:00

README.md

Storyboard Web Client

A WebClient for the OpenStack Storyboard project.

Project Resources

Getting Started

First of all be sure to have tox installed on your machine then:

Install the virtualenv containing nodejs: tox -evenv
Source the new path containing grunt: source .tox/grunt_no_api/bin/activate
Now you can launch the grunt tasks of storyboard-webclient, by default run the development server with the following command: grunt server

Grunt tasks

Here are the grunt tasks available with the storyboard-webclient project, the following commands must be prefixed by grunt, example for the first one, the command to run will be grunt jshint, the virtualenv must have been activated see previous section:

jshint: Runs a linter on the javascript sources files of the project, this will help us keeping style consistency across our files and can reduce the risk of bugs.
clean: Erases the temporary folders created by various grunt tasks, such as reports, cover and dist.
less: Compiles the themes files present in /src/theme/custom and /src/theme/custom using less compiler, the result which is a plain css file is stored into dist/styles/main.css
compile: Compiles all of our sources in the dist directory.
package: Built code into a release package.
build: Compile and packages our code.
server:dist: This task performs a full build of our application, and then runs that source in a local web server. It does no watching, it simply hosts the files.
server:prod: This task is identical to 'server:dist', with the exception that it will proxy the API requests against the production API. USE WITH CAUTION
server: Development server - runs a build and sets up concurrent watchers that will automatically lint, test, and refresh the code when a change is detected.
test: Run all the tests.
test:unit: This command will create a clean build against which our unit tests will be run. For more information, please see karma-unit.conf.js
test:integration: This command will create a clean build against which our integration tests will be run. For more information, please see karma-integration.conf.js
test:functional: This command will create a clean build against which our functional tests will be run. For more information, please see karma-functional.conf.js