The HTML, CSS, and JavaScript framework for James Cook University web applications and projects.
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 2705 commits ahead, 410 commits behind twbs:master.
Permalink
Failed to load latest commit information.
dist Update version to 1.0.0-beta.1 May 24, 2016
docs Fix broken link in docs Jun 15, 2017
grunt Update version to 1.0.0-beta.1 May 24, 2016
images Optimise background images Feb 1, 2016
js Update docs and dist maps May 24, 2016
nuget Update copyright years to 2016 Jan 1, 2016
scss Update version to 1.0.0-beta.1 May 24, 2016
.bowerrc JCU Bootstrap customisations Sep 22, 2015
.editorconfig Update README.md. Jul 25, 2015
.gitattributes Remove dropped v3 bootstrap-theme Sep 8, 2015
.gitignore Update to Jekyll v3.0.0. Oct 29, 2015
.gitmodules Remove assets submodule Feb 3, 2016
.hound.yml Fix Hound's JS config Oct 20, 2015
.travis.yml Travis CI: Temporarily disable caching Nov 30, 2015
CHANGELOG.md Add CDN info for image resources Jun 29, 2016
CNAME Update gh-pages cname Feb 3, 2016
CONTRIBUTING.md Add contributing template info Mar 14, 2016
Gemfile Bump scss_lint to v0.43.2. Dec 1, 2015
Gemfile.lock Bump scss_lint to v0.43.2. Dec 1, 2015
Gruntfile.js Update CDN rsync config Jan 18, 2018
README.md Packaging cleanup to JCU Web Framework May 24, 2016
_config.yml Update CDN links to official URLs Feb 11, 2018
bootstrap-LICENSE Packaging cleanup to JCU Web Framework May 24, 2016
bower.json Add tether as bower dependency Dec 15, 2015
composer.json remove less references from package files Jan 19, 2015
package.js Update version to 1.0.0-beta.1 May 24, 2016
package.json Update version to 1.0.0-beta.1 May 24, 2016
sache.json Add sache.json Dec 15, 2014

README.md

JCU Web Framework

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.

Table of contents

Copyright and disclaimer

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.

Quick start

Several quick start options are available:

Read the online documentation for information on the framework contents, templates and examples, and more.

What's included

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.

Bugs and feature requests

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

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.

Versioning

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.

Developers

David Beitey