Skip to content

Commit

Permalink
docs: updated docs to use yarn & lerna and removed test references
Browse files Browse the repository at this point in the history
  • Loading branch information
brecke committed Jul 26, 2019
1 parent 098146e commit b85026a
Showing 1 changed file with 5 additions and 27 deletions.
32 changes: 5 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
3akai-ux is the front-end for the Open Academic Environment project.

## Build status

[![Build Status](https://travis-ci.org/oaeproject/3akai-ux.png?branch=master)](https://travis-ci.org/oaeproject/3akai-ux)

## Installing OAE
Expand Down Expand Up @@ -34,39 +35,17 @@ Finally, uncomment the following lines in `nginx.conf`:

Reload nginx and HTTPS should work now.

## Off-line Development
## Offline 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](http://www.google.com/fonts#UsePlace:use/Collection:Open+Sans).

## Widget development

Documentation (WIP) on how to create custom OAE widgets can be found on the [Widget Wiki](https://github.com/oaeproject/3akai-ux/wiki/Widget-Development-%5BWIP%5D)

## Functional tests

### PhantomJS

In order to run the front-end test suite, [PhantomJS](http://phantomjs.org/) needs be installed. The instructions on how to install PhantomJS can be found on the [PhantomJS download page](http://phantomjs.org/download.html).

### CasperJS
### Install dependencies

In order to run the front-end test suite, [CasperJS](http://casperjs.org/), which relies on PhantomJS, needs to be installed. The instructions on how to install CasperJS can be found on the [CasperJS download page](http://casperjs.org/installation.html).

### 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
```
`lerna` and `yarn` are required to download 3akai-ux dependencies. To do so, run this command in your 3akai-ux directory: `lerna bootstrap`

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

Expand All @@ -76,10 +55,9 @@ The project website can be found at http://www.oaeproject.org. The [project blog

The mailing list used for Apereo OAE is [email protected]. 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](https://github.com/oaeproject/3akai-ux/issues). Ideas for new features and capabilities can be suggested and voted for in our [UserVoice page](http://oaeproject.uservoice.com).
Bugs and other issues can be reported in our [issue tracker](https://github.com/oaeproject/3akai-ux/issues).

## Special thanks to

- [BrowserStack](https://www.browserstack.com) for graciously supporting cross-browser testing.
- [Crowdin](http://crowdin.com/project/apereo-oae) for providing our internationalisation platform.

1 comment on commit b85026a

@datreeio
Copy link

@datreeio datreeio bot commented on b85026a Jul 26, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All Rules (5 / 5) Passed

👑 Good job! this pull request is aligned with your organization's best practices!

👉 You can review your rules settings at smart policy management 👈

👉 click here to view a full list of the events 👈

Please sign in to comment.