WAeUP Sampleuni
###############

`kofacustom.sampleuni` (further referred to as Sampleuni) is a Python package
providing a student information portal based on WAeUP.Kofa. It is a skeleton
package which can be used to create customized versions of Kofa.

For generic install instructions please see 

  http://kofa-doc.waeup.org/userdocs/install.html


Quick Install on Ubuntu 14.04 or 16.04
**************************************

If you want to install Sampleuni on a running Ubuntu system, the
following quick steps might be sufficient::

  ## install neccessary system packages as superuser
  $ sudo apt-get update && apt-get install -y  # update system
  $ sudo apt-get install python2.7-dev libxml2-dev libxslt1-dev zlib1g-dev python-virtualenv libssl-dev libffi-dev libjpeg-dev libfreetype6-dev libtiff-dev libopenjpeg-dev
  $ sudo ln -s /usr/include/freetype2 /usr/include/freetype2/freetype

  ## unpack sources as regular user (probably already done if you
  ## read this README)
  $ tar xzf waeup.sampleuni
  $ cd waeup.sampleuni

  ## create python sandbox and build kofa
  $ virtualenv py27
  $ source py27/bin/activate
  $ pip install --upgrade pip
  $ python bootstrap.py
  $ ./bin/buildout

To run Sampleuni, now do::

  ## startup Kofa in foreground (recommended for first start)
  $ ./bin/kofactl fg
  ## press CTRL-D to stop the kofa server

  ## startup Kofa in background
  $ ./bin/kofactl start
  $ ./bin/kofactl status  # check status, running or not
  $ ./bin/kofactl stop    # stop running instance (also 'restart' possible)

When Sampleuni is running, you can access the portal on port 8080. Open

  http://localhost:8080/

and enter the credentials (username 'grok', password 'grok' by
default) and name and add a `University`.

Congratulations, you got Sampleuni running.