Open Academic Environment (OAE) Front-End
JavaScript CSS HTML Nginx Shell
Latest commit 44ec3dc Nov 15, 2016 root (Release 12.4.2) Bump version
Permalink
Failed to load latest commit information.
admin Merge remote-tracking branch 'oaeproject/master' into inviting-guests Sep 15, 2015
bin Made CDN url configurable through environment variable Oct 1, 2014
docs (InvitingGuests) Add signin and signup in place of topnav signin and … Aug 10, 2015
etc/scripts Do not use CDN for now Oct 10, 2014
nginx
node_modules Merge branch 'issue-4105' of https://github.com/sallakarppinen/3akai-ux Jun 2, 2016
shared Increased boldness of Markdown table headers Jun 3, 2016
tests Pass in email when creating users in the casperjs tests Mar 9, 2016
tools (InvitingGuests/ReviewFollowup) Review followup Sep 22, 2015
ui Fix linting issues Mar 9, 2016
.editorconfig (MySearch) Add trailing whitespace back; don't trim whitespace for pr… Aug 31, 2015
.gitignore
.travis.yml Disable TravisCI tests Sep 24, 2015
COMMITTERS.txt Added translators and new contributors to the committers file Dec 6, 2013
Gruntfile.js Fix CDN replacement to only replace 'link' tag hrefs Sep 15, 2015
LICENSE Updating license URL to existing one Jun 13, 2013
README.md Added thank you note for crowdin Jul 7, 2015
package.json

README.md

Open Academic Environment (OAE Project)

3akai-ux is the front-end for the Open Academic Environment project.

Build status

Build Status

Installing OAE

Documentation on how to install and configure OAE can be found in the back-end repository.

Off-line Development

By default 3akai-ux uses the Open Sans font family available from Google's Web Font CDN. When developing locally without a live internet connection, that CDN will be inaccessible. To ensure maximum visual fidelity, those fonts can be installed as system fonts on the local machine. The entire collection can be downloaded from Google.

Widget development

Documentation (WIP) on how to create custom OAE widgets can be found on the Widget Wiki

Functional tests

PhantomJS

In order to run the front-end test suite, PhantomJS needs be installed. The instructions on how to install PhantomJS can be found on the PhantomJS download page.

CasperJS

In order to run the front-end test suite, CasperJS, which relies on PhantomJS, needs to be installed. The instructions on how to install CasperJS can be found on the CasperJS download page.

Install NPM dependencies

NPM is the package manager that downloads all the Node.js dependencies on which the 3akai-ux test suite relies. To tell NPM to download all the dependencies, run this command in your 3akai-ux directory:

npm install -d

Running the tests

The front-end test suite can be run using Grunt:

grunt test --qunit-host tenant.oae.com

Note that Hilary and its dependencies should be installed and running on your system before the tests can be run successfully.

Get in touch

The project website can be found at http://www.oaeproject.org. The project blog will be updated with the latest project news from time to time.

The mailing list used for Apereo OAE is oae@apereo.org. You can subscribe to the mailing list at https://groups.google.com/a/apereo.org/d/forum/oae.

Bugs and other issues can be reported in our issue tracker. Ideas for new features and capabilities can be suggested and voted for in our UserVoice page.

Special thanks to

  • BrowserStack for graciously supporting cross-browser testing.
  • Crowdin for providing our internationalisation platform.