6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-13 06:37:46 +00:00
Go to file
2019-07-04 10:16:09 +08:00
.github/ISSUE_TEMPLATE Add github template for questions 2019-05-23 12:59:18 +02:00
bin Migrate notes to a dedicated plugin 2019-07-04 09:31:12 +08:00
docs Migrate notes to a dedicated plugin 2019-07-04 09:31:12 +08:00
plugins Add pull/push hook to minio plugin 2019-07-04 09:31:12 +08:00
requirements Migrate notes to a dedicated plugin 2019-07-04 09:31:12 +08:00
tests Migrate notes to a dedicated plugin 2019-07-04 09:31:12 +08:00
tutor Fix lms.env.json syntax error 2019-07-04 10:16:09 +08:00
.gitignore Git-ignore entire build folder 2019-06-23 13:25:11 +02:00
.gitlab-ci.yml Fix docs deployment 2019-06-24 12:49:16 +02:00
.travis.yml Push plugin packages to pypi 2019-06-23 23:11:07 +02:00
CHANGELOG.md Migrate notes to a dedicated plugin 2019-07-04 09:31:12 +08:00
CONTRIBUTING.rst Migrate github repo to overhangio organization 2019-06-23 23:11:07 +02:00
LICENSE.txt gpl -> agpl 2019-01-18 15:19:18 +01:00
Makefile Migrate notes to a dedicated plugin 2019-07-04 09:31:12 +08:00
MANIFEST.in Fix missing templates in pypi install 2019-02-12 09:09:44 +01:00
README.rst Add gitlab CI badge to readme 2019-06-24 13:06:40 +02:00
setup.py Remove references to Regis' dockerhub account 2019-06-23 23:11:07 +02:00

.. _readme_intro_start:

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

.. image:: https://img.shields.io/travis/overhangio/tutor.svg?label=Release%20build
    :alt: Release build status
    :target: https://travis-ci.org/overhangio/tutor

.. image:: https://git.overhang.io/community/tutor/badges/master/pipeline.svg
    :alt: Release build status
    :target: https://git.overhang.io/community/tutor/commits/master

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

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

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

.. image:: https://img.shields.io/github/license/overhangio/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 fast, full of cool features, extendable, 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/overhangio/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: `video <https://www.youtube.com/watch?v=Oqc7c-3qFc4>`_, `slides <https://regisb.github.io/openedx2019/>`_.

.. _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/overhangio/tutor/issues/new/choose>`_. `Pull requests <https://github.com/overhangio/tutor/pulls>`_ will be happily examined, too!

.. _readme_contributing_end: