tutor

Go to file

Régis Behmo ab4bfcbff7 gpl -> agpl		2019-01-18 15:19:18 +01:00
.github	I'm pretty desperate at this point	2018-09-03 07:54:55 +02:00
android	Rename custom settings from "universal" to "tutor"	2018-12-26 19:27:08 +01:00
build	Simplify forum container configuration	2019-01-06 23:09:08 +01:00
data	Add openedx-assets command	2018-12-25 19:25:23 +01:00
deploy	Fix Makefile.env sourcing	2019-01-17 16:26:42 +01:00
docs	Open edX requires 4 Gb of RAM	2019-01-17 16:48:34 +01:00
.gitignore	Working Kubernetes instakk	2019-01-06 23:09:08 +01:00
.travis.yml	Migrate openedx-docker project to Tutor 👩‍🏫	2018-12-26 19:27:08 +01:00
CHANGELOG.md	Switch license to AGPL	2019-01-16 17:24:42 +01:00
LICENSE.txt	gpl -> agpl	2019-01-18 15:19:18 +01:00
Makefile	Move "make info" command to root folder	2019-01-16 17:19:34 +01:00
README.rst	Fix docs link (ssl not supported, yet)	2018-12-28 16:52:33 +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

**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/octNfEnvIA6jNohCBmODBKizE.png
    :alt: asciicast
    :target: https://asciinema.org/a/octNfEnvIA6jNohCBmODBKizE

Quickstart
----------

::

    git clone https://github.com/regisb/tutor
    cd tutor/deploy/local
    make all

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

Extensive documentation is available online: http://docs.tutor.overhang.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/tutor/issues/new>`_ so that we can discuss it. `Pull requests <https://github.com/regisb/tutor/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.