mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-11-15 09:44:07 +00:00
85 lines
3.4 KiB
ReStructuredText
85 lines
3.4 KiB
ReStructuredText
.. _readme_intro_start:
|
|
|
|
Tutor 🎓 The docker-based Open edX distribution designed for peace of mind
|
|
==========================================================================
|
|
|
|
.. image:: https://img.shields.io/travis/overhangio/tutor.svg?label=Release%20build
|
|
:alt: Release build status
|
|
:target: https://travis-ci.org/overhangio/tutor
|
|
|
|
.. image:: https://git.overhang.io/community/tutor/badges/master/pipeline.svg
|
|
:alt: Release build status
|
|
:target: https://git.overhang.io/community/tutor/commits/master
|
|
|
|
.. image:: https://img.shields.io/badge/docs-current-blue.svg
|
|
:alt: Documentation
|
|
:target: https://docs.tutor.overhang.io
|
|
|
|
.. image:: https://img.shields.io/github/issues/overhangio/tutor.svg
|
|
:alt: GitHub issues
|
|
:target: https://github.com/overhangio/tutor/issues
|
|
|
|
.. image:: https://img.shields.io/github/issues-closed/overhangio/tutor.svg?colorB=brightgreen
|
|
:alt: GitHub closed issues
|
|
:target: https://github.com/overhangio/tutor/issues?q=is%3Aclosed
|
|
|
|
.. image:: https://img.shields.io/github/license/overhangio/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 reliable, fast, extensible, and it is already used by dozens of Open edX platforms in the world.
|
|
|
|
Features
|
|
--------
|
|
|
|
* 100% `open source <https://github.com/overhangio/tutor>`__
|
|
* Runs entirely on Docker
|
|
* World-famous 1-click `installation and upgrades <https://docs.tutor.overhang.io/install.html>`_
|
|
* Extensible architecture with `plugins <https://docs.tutor.overhang.io/plugins.html>`_
|
|
* Works with `Kubernetes <https://docs.tutor.overhang.io/k8s.html>`_
|
|
* No technical skill required with the `1-click Tutor AWS image <https://docs.tutor.overhang.io/install.html#cloud_install>`_
|
|
|
|
.. _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/overhangio/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:
|
|
|
|
.. _whats_tutor_start:
|
|
|
|
What is Tutor?
|
|
--------------
|
|
|
|
Tutor was presented at the 2019 Open edX conference in San Diego, CA. Here's the 7-minute talk: `video <https://www.youtube.com/watch?v=Oqc7c-3qFc4>`_, `slides <https://regisb.github.io/openedx2019/>`_.
|
|
|
|
.. _whats_tutor_end:
|
|
|
|
.. _readme_contributing_start:
|
|
|
|
Contributing
|
|
------------
|
|
|
|
We are very much open to new ideas and 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/overhangio/tutor/issues/new/choose>`_. `Pull requests <https://github.com/overhangio/tutor/pulls>`_ will be happily examined, too!
|
|
|
|
.. _readme_contributing_end: |