Skip to main content

JCU Web Framework

The living style guide for University web applications.

Download

The framework can be downloaded or accessed in a number of different ways depending on the type of application being themed.

Contents

CDN-hosted resources

You can utilise our Content Distribution Network (CDN)-hosted resources to style your web application or site and avoid needing to download anything.

CSS & JS

  <link rel="stylesheet" href="https://cdn.web.jcu.io/1.0.0-beta.1/css/jcu.min.css" integrity="sha384-yvalFRKl+0g0tWrYJQwXPaf4oRFo9hOu7BssvfScVX9wdvvA+NjYtnAFm3sqP7LF" crossorigin="anonymous">
  <script src="https://cdn.web.jcu.io/1.0.0-beta.1/js/jcu.min.js" integrity="sha384-GXpe6UW5FXR+By2fTo2YeI+yVoY1QGkZdZpppWl3qboYFMqHL7zFEq+X6hRoB1gH" crossorigin="anonymous"></script>

Upgrading to a new release version is a matter of updating the included URLs and following any applicable Migration documentation.

If using the JavaScript resources above, ensure you have jQuery and Tether available on your page. If your page or application doesn’t already have them, you can also load these using CDN as well, via the following:

  <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js" integrity="sha384-8gBf6Y4YYq7Jx97PIqmTwLPin4hxIzQw5aDmUg/DDhul9fFpbbLcLh3nTIIDJKhx" crossorigin="anonymous"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.1.1/js/tether.min.js" integrity="sha384-MWq1Lnqj72tmjGdOKuNBn3E0gj3vWfy/1EmR5TVL8d8nGvwgy32YkCpKpTUhwBVv" crossorigin="anonymous"></script>

Images and other resources

It is also possible to reference any of the images or other content located on the CDN as well, like so:

<img src="https://cdn.web.jcu.io/1.0.0-beta.1/images/jcua-logo-campus-stack-full-colour.svg">

Relative paths refer to the content located in the dist/ directory. You can determine the path to content on the CDN by viewing https://github.com/jcu/web-framework/tree/master/dist.

Release packages

Download latest release See all versions

Releases are simply fully compiled zip archives, containing all the necessary files and resources to implement the JCU Web Framework in your project. This is best suited for:

  • Static web pages
  • Small to medium sites
  • Systems without Git available
  • Developers unfamiliar with Git

To apply to your site or system, see the Quick Start documentation.

To update to a new version of the framework, remove the old version and unzip the new version in the same area. Check the Migration notes first regarding what has changed and how your system needs to adapt. As with all systems, ensure you have backups and test in a development environment first.

From Git

Releases from Git

Access repository

Applications can track the framework’s releases through Git, a common distributed version control system (DVCS). This has the added benefit of simply being able to pull changes and checkout new versions and avoid manually handling files.

This is best suited for:

  • Larger websites or projects
  • Systems with Git installed
  • Projects using Git for version control

If your project is already using Git for version control, you can add the framework as a Git submodule, which will assist with managing updates.

To apply to your site or system, consult the Application Theming documentation. As different platforms work in different ways, we encourage you to submit your experiences as a pull request (or open an issue and we’ll help).

Source files

Let’s get building!

Download the complete project, including all source files for Sass, JavaScript and documentation. If you want to create your own flavour of framework, choose just specific parts, or do something else that’s a little out there, you’re in the right place.

This is best suited for:

  • Projects with specific styling requirements
  • Customising and tweaking the final theme
  • Selecting and reusing specific components
  • Users with experience with npm, Sass, Grunt and front-end build tools
  • Projects using Git for version control

To get started building, consult the documentation for Building for step-by-step instructions.