tutor

Go to file

Régis Behmo 2f9acb79d9 Fix install from source docs		2019-03-27 07:55:09 -07: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
cloud	Pluggable SMTP service	2019-03-20 18:45:09 +01:00
docs	Fix install from source docs	2019-03-27 07:55:09 -07:00
requirements	Fix pyyaml deprecated warning	2019-03-24 14:43:17 -07:00
tests	Move all yaml-related code to dedicated module	2019-03-24 14:34:50 -07:00
tutor	Fix broken android app build	2019-03-27 07:35:33 -07:00
.gitignore	Don't version tutor.spec	2019-03-09 11:17:48 +01:00
.travis.yml	Introduce the concept of "nightly" release	2019-03-22 23:37:59 +01:00
CHANGELOG.md	Fix missing configuration parameters for android environment	2019-03-27 07:35:28 -07: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	Fix CI unit tests on Mac OS	2019-03-24 12:24:22 -07:00
README.rst	Docs are now hosted with https	2019-02-20 13:53:22 +01:00
setup.py	Fix install from source docs	2019-03-27 07:55:09 -07: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/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 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. From the command line::

       sudo curl -L "https://github.com/regisb/tutor/releases/download/latest/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor
       sudo chmod +x /usr/local/bin/tutor

2. Run ``tutor local quickstart``
3. You're done!

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

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

Support
-------

To get community support, go to the official discussion forums: https://discuss.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 first discuss it on the `Tutor forum <https://discuss.overhang.io>`_. Did you find an issue with Tutor? Please first make sure that it's related to Tutor, and not an issue with Open edX. Then, `open an issue on Github <https://github.com/regisb/tutor/issues/new>`_. `Pull requests <https://github.com/regisb/tutor/pulls>`_ will be happily examined, too!