opendev/storyboard-webclient
Code Issues Proposed changes
OpenStack Task Tracking Browser Client
404 Commits 1 Branch 0 Tags 8 MiB
JavaScript 53.4%
HTML 41.1%
SCSS 4.3%
Shell 0.6%
Smarty 0.5%
cdf7944065
Go to file
Adam Coldrick cdf7944065 Render descriptions and comments as Markdown 
When displaying comments and descriptions for projects or stories,
render the content as Markdown before displaying it. This is a
simple way to support rich text descriptions and comments, and
there is no special editor as yet.

Any code in the supplied Markdown (indented by 4 spaces) will have
its syntax highlighted. The `highlightjs` module is used for syntax
highlighting and the `marked` module is used for parsing the
Markdown.

Also, stop eslint from raising an error when it thinks something is
undefined, and raise a warning instead. This is because the use of
`hljs` and `marked` was confusing the linter into thinking they
weren't defined.

Change-Id: I7896fd686a39e27f8068ee6db6747b2b5ab0ccfc
2015-09-22 10:04:53 +00:00
bin Removed nodeenv dependency 2014-08-12 17:02:07 -07:00
src Render descriptions and comments as Markdown 2015-09-22 10:04:53 +00:00
test Initial proposal for integration tests 2015-04-07 11:05:19 +02:00
.eslintrc Render descriptions and comments as Markdown 2015-09-22 10:04:53 +00:00
.gitignore Eabled custom dev configuration. 2014-12-01 07:18:07 -08:00
.gitreview Initial commit 2014-01-14 18:49:39 -08:00
bower.json Render descriptions and comments as Markdown 2015-09-22 10:04:53 +00:00
Gruntfile.js Render descriptions and comments as Markdown 2015-09-22 10:04:53 +00:00
karma-unit.conf.js Add grunt-lintspaces module to check cr-at-end in js files 2015-01-07 13:29:23 +01:00
LICENSE Initial commit 2014-01-14 18:49:39 -08:00
package.json Updated dependencies 2015-04-29 06:58:32 -07: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 Replace ci.o.o links with docs.o.o/infra 2015-05-14 21:38:19 +00: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/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

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.
  • 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
  • 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.
  • 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