6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-13 06:37:46 +00:00
Go to file
Silvio Tomatis b79cd1799b Make it possible to persist lms/cms logs to files
By symlinking /dev/stdout to a .log file, we make it possible for users
to manually persist lms/cms logs to a file.
2019-05-29 09:53:15 +02:00
.github/ISSUE_TEMPLATE Add github template for questions 2019-05-23 12:59:18 +02:00
bin Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
cloud Get rid of the "latest" release tag 2019-04-22 13:36:40 +02:00
docs Make it possible to persist lms/cms logs to files 2019-05-29 09:53:15 +02:00
requirements Switch from nose to unittest for running tests 2019-05-05 12:30:20 +02:00
tests Move all yaml-related code to dedicated module 2019-03-24 14:34:50 -07:00
tutor Make it possible to persist lms/cms logs to files 2019-05-29 09:53:15 +02:00
.gitignore Add __pycache__ to .gitignore 2019-04-19 23:08:26 +02:00
.travis.yml Simplify CI install/testing 2019-05-05 12:30:20 +02:00
CHANGELOG.md Fix installing a locally cloned requirement repository 2019-05-22 20:03:46 +02:00
CONTRIBUTING.rst Add basic contribution guidelines 2019-05-13 16:52:03 +02:00
LICENSE.txt gpl -> agpl 2019-01-18 15:19:18 +01:00
Makefile Simplify CI install/testing 2019-05-05 12:30:20 +02:00
MANIFEST.in Fix missing templates in pypi install 2019-02-12 09:09:44 +01:00
README.rst Add github template for questions 2019-05-23 12:59:18 +02:00
setup.py Fix install from source docs 2019-03-27 07:55:09 -07:00

.. _readme_intro_start:

Tutor 🎓 The docker-based Open edX distribution designed for peace of mind
==========================================================================

.. image:: https://img.shields.io/travis/regisb/tutor.svg
    :alt: Build status
    :target: https://travis-ci.org/regisb/tutor

.. image:: https://img.shields.io/badge/docs-current-brightgreen.svg
    :alt: Documentation
    :target: https://docs.tutor.overhang.io

.. image:: https://img.shields.io/github/issues/regisb/tutor.svg
    :alt: GitHub issues
    :target: https://github.com/regisb/tutor/issues

.. image:: https://img.shields.io/github/issues-closed/regisb/tutor.svg?colorB=brightgreen
    :alt: GitHub closed issues
    :target: https://github.com/regisb/tutor/issues?q=is%3Aclosed

.. image:: https://img.shields.io/github/license/regisb/tutor.svg
    :alt: AGPL License
    :target: https://www.gnu.org/licenses/agpl-3.0.en.html

**Tutor** is a docker-based `Open edX <https://openedx.org>`_ distribution, both for production and local development. The goal of Tutor is to make it easy to deploy, customize, upgrade and scale Open edX. Tutor is easy to use, fast, full of cool features, and it is already used by dozens of Open edX platforms in the world.

.. _readme_intro_end:

.. image:: ./docs/img/quickstart.gif
    :alt: Tutor local quickstart
    :target: https://terminalizer.com/view/91b0bfdd557

Quickstart
----------

1. Install the `latest stable release <https://github.com/regisb/tutor/releases>`_ of Tutor
2. Run ``tutor local quickstart``
3. You're done!

Documentation
-------------

Extensive documentation is available online: https://docs.tutor.overhang.io/

.. _readme_support_start:

Support
-------

To get community support, go to the official discussion forums: https://discuss.overhang.io.

.. _readme_support_end:

.. _whats_tutor_start:

What is Tutor?
--------------

Tutor was presented at the 2019 Open edX conference in San Diego, CA. Here's the 7-minute talk (`slides <https://regisb.github.io/openedx2019/>`_):

.. raw:: html
    
    <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/Oqc7c-3qFc4" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

.. _whats_tutor_end:

.. _readme_contributing_start:

Contributing
------------

We are very much open to new ideas and features for Tutor. If you have an improvement idea, feel free to first discuss it on the `Tutor forums <https://discuss.overhang.io>`_. If you are not quite familiar with Open edX or if you need technical advice, the forums are a great place to start, too. Did you find an issue with Tutor? Please first make sure that it's related to Tutor, and not an upstream issue with Open edX. Then, `open an issue on Github <https://github.com/regisb/tutor/issues/new/choose>`_. `Pull requests <https://github.com/regisb/tutor/pulls>`_ will be happily examined, too!

.. _readme_contributing_end: