The goals of the UI Library are to:
- unify the CS2 UI.
- speed up development time.
- make the CS2 UI stunningly beautiful and a joy for the end-user to work in.
by doing the following:
- standardize the UI codebase.
- give developers code patterns to seamlessly plug in.
- document standards and guidelines for working in the CS2 UI codebase.
Current features to help with development are as follows:
- Angular templates: Any file with the
.tpl.html
extension is converted to an Angular template and combined in thebuild/js/templates.js
file during development. - Markdown (
*.md
) files: Markdown files are parsed and saved as an Angular template. - Code syntax highlighting inside of markdown code blocks.
- HTML inside of markdown files is also allowed.
- Clone the repo
- Run
npm install
grunt
: runs a development build with non-optimized assets.grunt -P
orgrunt --prod
: runs a production build with optimized assets.grunt deploy
: runs a production build and automatically deploys to thegh-pages
branch for GitHub pages.