b3ec6245cd
`node_version` is set to cause a version of node to be installed that actually works to build StoryBoard on bionic. The remaining issue with this job is that zuul currently uploads everything in the dist/ directory to tarballs.openstack.org. The output directory of our build script is also modified to not be "dist" to stop this causing an untarballed webclient being uploaded to tarballs.openstack.org. `create_tarball_directory` is set in .zuul.yaml to reflect the new location. Needed-By: I9f435c12df2b355ac9d735e9eda3f70cc396f1d9 Change-Id: Ia8bf1dc99ee18d31a6d269b243eade71fe519b7d
StoryBoard Web Client
A WebClient for the OpenStack StoryBoard project.
Project Resources
- Project status, bugs, and blueprints
- Source code
- Documentation
- Additional resources are linked from the project wiki page
- How to contribute to OpenStack
- Code reviews workflow
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.jsnpm 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.jsnpm 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