opendev/storyboard-webclient
Code Issues Proposed changes
OpenStack Task Tracking Browser Client
771 Commits 1 Branch 0 Tags 8 MiB
JavaScript 53.4%
HTML 41.1%
SCSS 4.3%
Shell 0.6%
Smarty 0.5%
9eda525da3
Go to file
Zuul 9eda525da3 Merge "Replace marked.js with markdown-it.js"
2017-12-22 01:09:15 +00:00
bin Removed nodeenv dependency 2014-08-12 17:02:07 -07:00
src Replace marked.js with markdown-it.js 2017-11-09 21:44:57 +00:00
test Make the docs-draft build point to storyboard-dev 2016-05-19 14:19:55 +00:00
.eslintignore Removed grunt:eslint in favor of just running eslint 2016-04-12 07:29:06 -07:00
.eslintrc Render descriptions and comments as Markdown 2015-09-22 10:04:53 +00:00
.gitignore Display the most recent commit SHA on the about page 2015-12-16 15:41:39 +00:00
.gitreview Initial commit 2014-01-14 18:49:39 -08:00
.zuul.yaml Migrate some jobs in-tree 2017-12-15 17:48:49 +01:00
bindep.txt Move other-requirements.txt to bindep.txt 2016-08-12 19:31:07 +02:00
bower.json Replace marked.js with markdown-it.js 2017-11-09 21:44:57 +00:00
Gruntfile.js removed open option from npm serve 2017-02-23 08:19:40 -08:00
karma.conf.js Renamed karma-unit.conf.js 2016-05-18 16:54:01 +00:00
LICENSE Initial commit 2014-01-14 18:49:39 -08:00
package.json removed open option from npm serve 2017-02-23 08:19:40 -08:00
protractor-integration.conf.js Initial proposal for integration tests 2015-04-07 11:05:19 +02:00
protractor.conf.js Enabled eslint:strict 2015-03-16 14:02:36 -07:00
README.md Add Worklists and Boards to About Page 2016-08-17 01:00:18 +09:00
tox.ini Upgrade node in tox.ini to newest LTS (6.10.2) 2017-04-11 18:25:13 +01: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/venv/bin/activate
  • Now you can launch the grunt tasks of storyboard-webclient, by default run the development server with the following command: grunt serve

NPM Commands

The following are commands that may be used during project development.

  • npm run lint: 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.
  • npm run clean: Erases the temporary folders created by various grunt tasks, such as reports, cover and dist.
  • npm run build: Compile and packages our code.
  • npm run serve: Development server - runs a build and sets up concurrent watchers that will automatically lint, test, and refresh the code when a change is detected.
  • npm run 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
  • npm run test-integration: This command will create a clean build against which our functional tests will be run. For more information, please see protractor-integration.conf.js
  • npm run test-functional: This command will create a clean build against which our functional tests will be run. For more information, please see protractor.conf.js

Grunt tasks

For more detailed development, the following commands are available via grunt. To run them, you will need to install grunt globally: npm install -g grunt.

  • compile: Compiles all of our sources in the dist directory.
  • package: Built code into a release package.
  • serve: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.
  • serve: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