The JCU Web Framework is a collection of reusable front-end web components and examples for use by the University community. Based upon Bootstrap, this framework makes for faster and easier web development, and aims to foster consistency between web projects.
To get started, check out the documentation.
Portions of code and documentation copyright 2016 James Cook University and 2011-2016 Twitter, Inc.
Content, including text, imagery and styles, included in documentation and examples has been drawn from publicly-available sources and is used solely to illustrate the functionality present within the JCU Web Framework.
Documentation is a derivative of that provided in Bootstrap at http://getbootstrap.com, used under Creative Commons Attribution (CC-BY 3.0) licensing.
Open Sans font licensed under Apache License, version 2.0.
WebHostingHub Glyph customizer licensed under MIT licensing. Original font is licensed under the SIL Open Font License.
Bootstrap source code licensed under the MIT Licence, see the
bootstrap-LICENSE file in this repository for details.
Several quick start options are available:
- Download the latest release.
- Clone the repo:
git clone https://github.com/jcu/web-framework.git
Read the online documentation for information on the framework contents, templates and examples, and more.
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
jcu-web-framework/
├── css/
│ ├── jcu.css
│ ├── jcu.css.map
│ ├── jcu.min.css
│ └── jcu.min.css.map
├── js/
│ ├── jcu.js
│ └── jcu.min.js
├── images/
│ ├── *.{svg,jpg,ico}
│ └── ...
└── font/
├── *.{eot,svg,ttf,woff}
└── ...
We provide compiled CSS and JS (jcu.*), as well as compiled and minified
CSS and JS (jcu.min.*). CSS source
maps
(jcu.*.map) are available for use with certain browsers' developer
tools.
In addition, we provide a variety of imagery for use within pages (such as backgrounds images, for which there are utility CSS classes available), and fonts for use in typography and as iconography.
Found a bug or have a feature request? Search for existing and closed issues on our issue tracker. If your problem or idea is not addressed yet, please open a new issue.
Documentation, included in this repo in the root directory, is built with Jekyll and publicly hosted at https://web.jcu.io. The docs may also be run locally.
The JCU Web Framework follows Bootstrap's versioning and uses Semantic Versioning.
For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.
See the CHANGELOG for changes between versions.
David Beitey