search

vault19 / django-courses

Simple Django to manage courses
MIT License
6 stars 5 forks source link
django django-application education hacktoberfest python

readme

======= Courses

.. image:: https://img.shields.io/pypi/pyversions/django-courses.svg :alt: PyPI - Python Version :target: https://pypi.org/project/django-courses/

.. image:: https://img.shields.io/pypi/djversions/django-courses :alt: PyPI - Django Version :target: https://pypi.org/project/django-courses/

.. image:: https://img.shields.io/pypi/format/django-courses :alt: PyPI - Format :target: https://pypi.org/project/django-courses/

.. image:: https://img.shields.io/github/checks-status/vault19/django-courses/main :alt: GitHub branch checks state :target: https://github.com/vault19/django-courses/actions

.. image:: https://img.shields.io/github/license/vault19/django-courses.svg :alt: LICENSE :target: https://github.com/vault19/django-courses/blob/master/LICENSE

Courses is a simple Django app to manage online courses (education). Application is already used by civic association SPy o.z. <https://python.sk/o_nas/>_ (non-profit) for project "Teaching with hardware" in Slovak "Učíme s hardvérom": https://kurzy.ucimesharverom.sk

Project "Učíme s hardvérom" is run in Slovak language (however this app is in English, but has Slovak translations) and is aimed for Slovak teachers to introduce hardware (such as BBC microbit <https://microbit.org/>_) into computing lessons at primary and secondary schools.

Read more in our **documentation** <https://vault19.github.io/django-courses/html/>_.

Quick start

  1. Install django-courses via pip::

    pip install django-courses

Alternatively install latest development version from Github::

pip install https://github.com/vault19/django-courses/archive/refs/heads/main.zip

  1. Add "courses" to your INSTALLED_APPS setting like this::

    INSTALLED_APPS = [ ... 'wkhtmltopdf', 'courses', ]

  2. Include the polls URLconf in your project urls.py like this::

    path("", include("courses.urls")),

  3. Run python manage.py migrate to create the courses tables in DB.

  4. Start the development server and visit http://127.0.0.1:8000/admin/ to manage your courses (you'll need the Admin app enabled).

  5. Visit http://127.0.0.1:8000/ to view the courses list.

Contributing

All contributions are welcome! It doesnt have to be code, there are more possibilities how to get involved.

We have written extensive how to for beginners. Read more in our documentation <https://vault19.github.io/django-courses/html/contributing.html>_.

Support

Vault19 o.z. <https://vault19.eu>_ (non profit micro hackerspace) did this app because SPy o.z. <https://python.sk/o_nas/> (non profit supporting Slovak Python community) needed something for better management of their courses. We like to program and we wanted to design a clean Django <https://www.djangoproject.com/> app and learn one or two things in the process...