Vowel is a Virtual Online Workspace for Education and Learning.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Sam Black e98f0ae33a Merge branch 'release/20180716' 3 years ago
LICENCES Use socketio to transmit when the user is viewing the page and remove timeme use. 4 years ago
deployment Missing ';' 5 years ago
docs/developer Add what the documentation covers. 6 years ago
migrations Add slug name for organisations. 4 years ago
vowel Get lesson and assessment IDs to retrieve engagement information. 4 years ago
.gitignore Ignore SonarQube 4 years ago
CHANGELOG.rst Add changelog info 4 years ago
LICENCE Initial project setup 7 years ago
README.rst Add missing PDF extraction support 5 years ago
requirements.testing.txt Add mock converters to allow testing of converter logic without a running Flask app. 5 years ago
requirements.txt Remove gravatar. 4 years ago
run.py Merge branch 'develop' of ssh://code.lapwing.org:22443/vowel/vowel into develop 4 years ago
vowel.yaml Bump the version 4 years ago


Lapwing.Org: Vowel


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.


See CHANGELOG.rst for full list of changes.



- 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


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



#. 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 ```` 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}" &``



#. 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``


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
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.