tutor

Go to file

Régis Behmo 5b4beed1d1 Minimum required click version is 7.0 Close #171		2019-02-13 17:14:10 +01:00
.github	Tutor v3 complete rewrite	2019-02-09 20:30:01 +01:00
bin	Tutor v3 complete rewrite	2019-02-09 20:30:01 +01:00
docs	Clarify dev docs on theming	2019-02-13 08:54:10 +01:00
requirements	Minimum required click version is 7.0	2019-02-13 17:14:10 +01:00
tutor	Fix `runserver` dev command	2019-02-13 17:09:07 +01:00
.gitignore	Tutor v3 complete rewrite	2019-02-09 20:30:01 +01:00
.travis.yml	Better CI	2019-02-11 09:38:34 +01:00
CHANGELOG.md	Minimum required click version is 7.0	2019-02-13 17:14:10 +01:00
LICENSE.txt	gpl -> agpl	2019-01-18 15:19:18 +01:00
MANIFEST.in	Fix missing templates in pypi install	2019-02-12 09:09:44 +01:00
Makefile	Better CI	2019-02-11 09:38:34 +01:00
README.rst	Gif animation for quickstart	2019-02-10 19:29:37 +01:00
setup.py	Minimum required click version is 7.0	2019-02-13 17:14:10 +01:00
tutor.spec	Tutor v3 complete rewrite	2019-02-09 20:30:01 +01:00

README.rst

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

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

.. 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 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:: ./docs/img/quickstart.gif
    :alt: Tutor local quickstart
    :target: https://terminalizer.com/view/91b0bfdd557

Quickstart
----------

1. `Download <https://github.com/regisb/tutor/releases>`_ the latest stable release of Tutor, uncompress the file and place the ``tutor`` executable in your path.
2. Run ``tutor local quickstart``
3. You're done!

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

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

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

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/tutor/issues/new>`_ so that we can discuss it. `Pull requests <https://github.com/regisb/tutor/pulls>`_ will be happily examined, too!