christianlight/tutor
7
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-05-29 20:30:48 +00:00
Code Issues Releases Activity
387 Commits 8 Branches 122 Tags 31 MiB
Python 93.4%
Dockerfile 3.7%
Shell 1.5%
Makefile 1.1%
Jinja 0.3%
847678bb07
Go to file
Régis Behmo 847678bb07 Get rid of the "latest" release tag 
The "latest" tag is a pain to maintain: it's a tag that we delete and
re-create at every release. Whenever we delete it, the binaries become
unavailable on Github until they are re-generated. Thus, from now on, we
conform to good practices (as examplified by the
github.com/docker/compose) project and distribute only pinned release.

The "nightly" tag remains, for now, as it allows us to distribute beta
features. It may disappear in the future.
2019-04-22 13:36:40 +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 Get rid of the "latest" release tag 2019-04-22 13:36:40 +02:00
requirements Simplify docs requirement management 2019-04-20 00:47:20 +02:00
tests Move all yaml-related code to dedicated module 2019-03-24 14:34:50 -07:00
tutor Enable forum only when necessary on k8s 2019-04-22 12:07:34 +02:00
.gitignore Add __pycache__ to .gitignore 2019-04-19 23:08:26 +02:00
.travis.yml Get rid of the "latest" release tag 2019-04-22 13:36:40 +02:00
CHANGELOG.md Pluggable lms/cms/forum 2019-04-22 11:59:53 +02:00
LICENSE.txt gpl -> agpl 2019-01-18 15:19:18 +01:00
Makefile Get rid of the "latest" release tag 2019-04-22 13:36:40 +02:00
MANIFEST.in Fix missing templates in pypi install 2019-02-12 09:09:44 +01:00
README.rst Get rid of the "latest" release tag 2019-04-22 13:36:40 +02: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. Install the `latest stable release <https://github.com/regisb/tutor/releases>`_ of Tutor (`Instructions for the command line <https://docs.tutor.overhang.io/install.html#direct-binary-downloads>`_)
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!