Vowel is a Virtual Online Workspace for Education and Learning.
選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。
 
 
 
 
Sam Black e98f0ae33a Merge branch 'release/20180716' 2年前
LICENCES Add D3, C3 and initial analytics view 2年前
deployment Missing ';' 3年前
docs/developer Add what the documentation covers. 4年前
migrations Add slug name for organisations. 2年前
vowel Get lesson and assessment IDs to retrieve engagement information. 2年前
.gitignore Ignore SonarQube 2年前
CHANGELOG.rst Add changelog info 2年前
LICENCE Initial project setup 5年前
README.rst Add missing PDF extraction support 3年前
requirements.testing.txt Add mock converters to allow testing of converter logic without a running Flask app. 3年前
requirements.txt Remove gravatar. 2年前
run.py Merge branch 'develop' of ssh://code.lapwing.org:22443/vowel/vowel into develop 2年前
vowel.yaml Bump the version 2年前

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.