christianlight/tutor
7
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-05-29 12:20:49 +00:00
Code Issues Releases Activity
408 Commits 8 Branches 122 Tags 31 MiB
Python 93.4%
Dockerfile 3.7%
Shell 1.5%
Makefile 1.1%
Jinja 0.3%
9dd4c26706
Go to file
Régis Behmo 9dd4c26706 Introduce automatic code formatting/linting 
Code formatting makes sure that the python code looks decent, but it
does not check for coding errors.
https://black.readthedocs.io/en/stable/

Code linting runs static error detection on the python code, but does
not bother about formatting: https://pylint.readthedocs.io/en/latest/
2019-05-05 12:30:20 +02: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 Get rid of the "latest" release tag 2019-04-22 13:36:40 +02:00
docs Introduce automatic code formatting/linting 2019-05-05 12:30:20 +02:00
requirements Introduce automatic code formatting/linting 2019-05-05 12:30:20 +02:00
tests Move all yaml-related code to dedicated module 2019-03-24 14:34:50 -07:00
tutor Do not require bash to be installed in docker containers. 2019-05-03 07:25:49 +02:00
.gitignore Add __pycache__ to .gitignore 2019-04-19 23:08:26 +02:00
.travis.yml Better release descriptions 2019-04-22 15:15:47 +02:00
CHANGELOG.md Fix triple course display in LMS search dashboard 2019-04-29 19:41:53 +02:00
LICENSE.txt gpl -> agpl 2019-01-18 15:19:18 +01:00
Makefile Introduce automatic code formatting/linting 2019-05-05 12:30:20 +02:00
MANIFEST.in Fix missing templates in pypi install 2019-02-12 09:09:44 +01:00
README.rst Improve docs wording and de-duplicate from readme 2019-04-25 09:36:18 +02:00
setup.py Fix install from source docs 2019-03-27 07:55:09 -07:00

README.rst 

.. _readme_intro_start:

Tutor 🎓 The docker-based Open edX distribution designed for peace of mind
==========================================================================

.. 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 docker-based `Open edX <https://openedx.org>`_ distribution, both for production and local development. The goal of Tutor is to make it easy to deploy, customize, upgrade and scale Open edX. Tutor is easy to use, fast, full of cool features, and it is already used by dozens of Open edX platforms in the world.

.. _readme_intro_end:

.. image:: ./docs/img/quickstart.gif
    :alt: Tutor local quickstart
    :target: https://terminalizer.com/view/91b0bfdd557

Quickstart
----------

1. Install the `latest stable release <https://github.com/regisb/tutor/releases>`_ of Tutor
2. Run ``tutor local quickstart``
3. You're done!

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

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

.. _readme_support_start:

Support
-------

To get community support, go to the official discussion forums: https://discuss.overhang.io.

.. _readme_support_end:

.. _readme_contributing_start:

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

We are very much open to new ideas, features for Tutor. If you have an improvement idea, feel free to first discuss it on the `Tutor forums <https://discuss.overhang.io>`_. If you are not quite familiar with Open edX or if you need technical advice, the forums are a great place to start, too. Did you find an issue with Tutor? Please first make sure that it's related to Tutor, and not an upstream 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!

.. _readme_contributing_end: