README

OU Web UI is a set of design patterns, components and templates so we can provide our students with a consistent user experience.

It is a part of the same family of work as the design used for the OU public website but is more tailored to the requirements of our students and their study journey. This is the fifth version of the framework (v5).

To get started, check out http://the-open-university.github.io/ou-web-ui/!

Quick start
Bugs and feature requests
Documentation
Contributing
Community
Versioning
Creators
Copyright and license

Quick start

Several quick start options are available:

Download the latest release.
Clone the repo: git clone https://github.com/the-open-university/ou-web-ui.git.
Install with Bower: (coming soon).
Install with npm: (coming soon).
Install with Meteor: (coming soon).
Install with Composer: (coming soon).

Read the Getting started page 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:

ou-web-ui/
├── css/
│   ├── ou-web-ui.css
│   ├── ou-web-ui.css.map
│   ├── ou-web-ui.min.css
│   ├── ou-web-ui.min.css.map
├── js/
│   ├── ou-web-ui.js
│   └── ou-web-ui.min.js
└── fonts/
    ├── glyphicons-halflings-regular.eot
    ├── glyphicons-halflings-regular.svg
    ├── glyphicons-halflings-regular.ttf
    ├── glyphicons-halflings-regular.woff
    └── glyphicons-halflings-regular.woff2

We provide compiled CSS and JS (ou-web-ui.*), as well as compiled and minified CSS and JS (ou-web-ui.min.*). CSS source maps (ou-web-ui.*.map) are available for use with certain browsers' developer tools. Fonts from Glyphicons are included.

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

OU Web UI's documentation, included in this repo in the root directory, is built with Jekyll and publicly hosted on GitHub Pages at http://the-open-university.github.io/ou-web-ui. The docs may also be run locally.

Running documentation locally

If necessary, install Jekyll and other Ruby dependencies with bundle install. Note for Windows users: Read this unofficial guide to get Jekyll up and running without problems.
From the root /ou-web-ui directory, run bundle exec jekyll serve in the command line.
Open http://localhost:9001 in your browser, and voilà.

Learn more about using Jekyll by reading its documentation.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, if your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, OU Web UI is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.

See the Releases section of our GitHub project for changelogs for each release version of OU Web UI.

the-open-university / ou-web-ui

Maintainers

Details