Vowel is a Virtual Online Workspace for Education and Learning.
Go to file
Sam Black e98f0ae33a Merge branch 'release/20180716' 2018-07-16 13:51:26 +01:00
LICENCES Use socketio to transmit when the user is viewing the page and remove timeme use. 2018-01-25 12:27:45 +00:00
deployment Missing ';' 2017-03-22 20:27:52 +00:00
docs/developer Add what the documentation covers. 2016-03-05 13:26:25 +00:00
migrations Add slug name for organisations. 2018-02-12 17:26:18 +00:00
vowel Get lesson and assessment IDs to retrieve engagement information. 2018-03-07 19:42:30 +00:00
.gitignore Ignore SonarQube 2017-10-27 18:12:54 +01:00
CHANGELOG.rst Add changelog info 2018-02-21 09:47:56 +00:00
LICENCE Initial project setup 2015-03-16 21:31:20 +00:00
README.rst Add missing PDF extraction support 2017-03-22 20:28:25 +00:00
requirements.testing.txt Add mock converters to allow testing of converter logic without a running Flask app. 2016-12-10 20:13:13 +00:00
requirements.txt Remove gravatar. 2018-02-07 17:16:53 +00:00
run.py Merge branch 'develop' of ssh://code.lapwing.org:22443/vowel/vowel into develop 2018-01-05 17:52:30 +00:00
vowel.yaml Bump the version 2017-11-30 22:41:13 +00:00

README.rst

==================
Lapwing.Org: Vowel
==================

About
=====

Vowel is a Virtual Online Workspace for Education and Learning.

The aim is to facilitate remote learning and training,
initially for further education and 
company training organisations.


ChangeLog
=========

See CHANGELOG.rst for full list of changes.


Requirements
============

Software
--------

- PostgreSQL (9.5 or greater)
- Redis (3.2 or greater)
- Python 3 (3.5 or greater)
- LibreOffice (5.0 or greater)
- Poppler (poppler-glib 0.45 or greater)
- Python 3 GOBject

Hardware
--------

- 1GB RAM
- 1CPU core
- At least 20GB HDD/SSD for storage


Setup
=====


virtualenv
----------

#. Ensure the software requirements above are met and running
#. ``mkvirtualenv vowel``
#. ``git clone git@github.com:LapwingOrg/vowel.git && cd vowel``
#. ``pip install -r requirements.txt``
#. ``mkdir instance && cp config.py instance && nano instance/config.py``

   - Setup you configuation options here,
     such as PostgreSQL connection, file upload location, secret key, etc.
#. ``FLASK_APP=$(pwd)/run.py flask first_run``

   - Enter admin email and password.
#. ``FLASK_APP=$(pwd)/run.py flask run``
#. Goto ``http://127.0.0.1:5000`` and login.
#. Background workers will not run unless started,
   recommended that they are run in separate terminals

   - ``source "./deployment/rq_settings.conf"``
   - ``source "./instance/rq_settings.conf"``
   - ``~/virtualenvs/vowel/bin/rqworker -u "${RQ_REDIS_URL}" high default low &``
   - ``~/virtualenvs/vowel/bin/rqscheduler -u "${RQ_REDIS_URL}" &``


Testing
=======

virtualenv
----------

#. Ensure the software requirements above are met and running
#. ``workon vowel && cd <PATH TO>/vowel``
#. ``pip install -r requirements.testing.txt``
#. ``nosetests -w testing/unittests``


Licence
=======

Vowel is Copyright (C) 2015, 2016, 2017 Sam Black samwwwblack@lapwing.org.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.
If not, see `http://www.gnu.org/licenses/ <http://www.gnu.org/licenses/>`_.

Further licences are listed in the LICENCES directory.