christianlight
/
tutor
mirror of https://github.com/ChristianLight/tutor.git
7
0
Fork 0
Code Issues Releases Activity
239 Commits 8 Branches 122 Tags 31 MiB
Python 93.4%
Dockerfile 3.7%
Shell 1.5%
Makefile 1.1%
Jinja 0.3%
Go to file
Régis Behmo 4331bc5712 Tutor v3 complete rewrite 
Replace all make commands by a single "tutor" binary. Environment and
data are all moved to ~/.tutor/local/share/tutor. We take the
opportunity to add a web UI and revamp the documentation.

This is a complete rewrite.

Close #121.
Close #147.
 		2019-02-09 20:30:01 +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 Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
requirements Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
tutor Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
.gitignore Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
.travis.yml Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
CHANGELOG.md Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
LICENSE.txt gpl -> agpl 2019-01-18 15:19:18 +01:00
Makefile Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
README.rst Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
setup.py Tutor v3 complete rewrite 2019-02-09 20:30:01 +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:: https://asciinema.org/a/octNfEnvIA6jNohCBmODBKizE.png
    :alt: asciicast
    :target: https://asciinema.org/a/octNfEnvIA6jNohCBmODBKizE

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!