Tutor 🎓 Open edX 1-click install for everyone
==============================================

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

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

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

**Tutor** is a one-click install of `Open edX <https://openedx.org>`_, both for production and local development, inside docker containers. Tutor is easy to run, fast, full of cool features, and it is already used by dozens of Open edX platforms in the world.

.. image:: https://asciinema.org/a/6DowVk4iJf3AJ2m8xlXDWJKh3.png
    :alt: asciicast
    :target: https://asciinema.org/a/6DowVk4iJf3AJ2m8xlXDWJKh3

Quickstart
----------

::

    git clone https://github.com/regisb/openedx-docker
    cd openedx-docker/
    make local

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

Extensive documentation is available online: https://tutor.readthedocs.io/

How to contribute
-----------------

We go to great lengths to make it as easy as possible for people to run Open edX inside Docker containers. If you have an improvement idea, feel free to `open an issue on Github <https://github.com/regisb/openedx-docker/issues/new>`_ so that we can discuss it. `Pull requests <https://github.com/regisb/openedx-docker/pulls>`_ will be happily examined, too! However, we should be careful to keep the project lean and simple: both to use and to modify. Optional features should not make the user experience more complex. Instead, documentation on how to add the feature is preferred.