opendev/storyboard-webclient
Code Issues Proposed changes
OpenStack Task Tracking Browser Client
213 Commits 1 Branch 0 Tags 8 MiB
JavaScript 53.4%
HTML 41.1%
SCSS 4.3%
Shell 0.6%
Smarty 0.5%
ad453400de
Go to file
Michael Krotscheck ad453400de Formalized Resource Criteria API 
An effort to abstract query parameters so that the resources inform
the system itself how the API is exposed. Could be the first step in
making our API self-describing.

- Deprecated Browse, it was serving only as an abstraction layer
  for Criteria.
- The Criteria service now provides several lambda builders to assist
  in the generation of search criteria. Filtering criteria against a
  resource, mapping criteria against parameters, and generating search
  lambdas.
- Search Criteria controller now has an initialization method that
  allows you to configure it at runtime to the resource it's supposed to
  provide search criteria for.
- Criteria Tag Item has been split out to be more generic.
- Managing criteria has been delegated to the resource itself. Now
  it falls to Project, Story, etc. to inform the system what fields
  it accepts as query parameters.
- Common text criteria resolver has been added.
- Header controller has been switched to use new Resource Criteria API.
- Stories may now be queried on the Story Status field.
- Services are now generated via a service factory rather than by
  using storyboardApiSignature.
- Search is now handled via the resource.search() method.

Change-Id: I1e355320c90f7cdc8cb6ee2191fe819ff7094665
2014-08-11 07:43:54 -07:00
bin Fix API launch 2014-02-28 14:08:34 -08: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 New StoryBoard Logo 2014-07-16 07:35:25 -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 Updated bower 2014-07-15 14:41:46 -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