opendev
/
storyboard-webclient
Code Issues Proposed changes
OpenStack Task Tracking Browser Client
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
931 Commits
1 Branch
Branch: master
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'master'
${ noResults }
Adam Coldrick c445307dc2 Reinstate "Add transpiling as a step in the build process" 3 months ago
bin Remove bower and add yarn support 2 years ago
src Reinstate "Add transpiling as a step in the build process" 3 months ago
test Make the docs-draft build point to storyboard-dev 3 years ago
.eslintignore Fix post job by setting some variables 11 months ago
.eslintrc Render descriptions and comments as Markdown 4 years ago
.gitignore Remove bower and add yarn support 2 years ago
.gitreview OpenDev Migration Patch 10 months ago
.zuul.yaml Override javascript_content_dir in build job 10 months ago
Gruntfile.js Reinstate "Add transpiling as a step in the build process" 3 months ago
LICENSE Initial commit 6 years ago
README.md Add Worklists and Boards to About Page 3 years ago
bindep.txt Move other-requirements.txt to bindep.txt 3 years ago
karma.conf.js Fix post job by setting some variables 11 months ago
package.json Reinstate "Add transpiling as a step in the build process" 3 months ago
protractor-integration.conf.js Initial proposal for integration tests 4 years ago
protractor.conf.js Enabled eslint:strict 5 years ago
tox.ini Rebuild node-sass bindings when running the webclient dev server 1 year ago
yarn.lock Reinstate "Add transpiling as a step in the build process" 3 months ago

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