https://github.com/wilmerm/django-tours

Django app to display tours with shepherdjs
https://github.com/wilmerm/django-tours

django django-framework django-tours python python-library python3 shepherd tours

Last synced: 2 months ago
JSON representation

Django app to display tours with shepherdjs

• Host: GitHub
• URL: https://github.com/wilmerm/django-tours
• Owner: wilmerm
• License: mit
• Created: 2023-12-04T06:54:34.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-18T16:58:45.000Z (6 months ago)
• Last Synced: 2024-09-27T16:41:00.840Z (3 months ago)
• Topics: django, django-framework, django-tours, python, python-library, python3, shepherd, tours
• Language: Python
• Homepage:
• Size: 37.1 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# django-tours

Django app to display tours with [shepherdjs](https://shepherdjs.dev/)

![Python Logo](https://www.python.org/static/community_logos/python-logo.png "Sample inline image")

![django-tours-1](https://github.com/wilmerm/django-tours/assets/44853160/d7a8c20f-ddb1-4f93-b287-e143813aef95)

## Instalation

```sh

pip install django-tours

```

## Use

### Add to installed applications

```py

# settings.py

INSTALLED_APPS = [

    # ...

    'tours',

    # ...

]

```

### Optional configuration:

**If you want to set default variables, you can add the following in your settings.py file:**

```py

# settings.py

DEFAULT_SHEPHERD_JS = 'https://cdn.jsdelivr.net/npm/shepherd.js@latest/dist/js/shepherd.min.js'

DEFAULT_SHEPHERD_CSS = 'https://cdn.jsdelivr.net/npm/shepherd.js@latest/dist/css/shepherd.css'

```

### Add the URLs

```py

urlpatterns = [

    # ...

    path('tours/', include('tours.urls')),

    # ...

]

```

### Run the migrations

```sh

python manage.py migrate

```

### Load tours into the template

```django

{% load tours %}

{% load_tours request %}

```

## Licence

This project is licensed under the MIT License. See [LICENSE](LICENSE) file for details.

## Proyect Status

This project is in Production/Stable ✔

## Contribution 💗

If you find value in this project and would like to show your support, please consider making a donation via PayPal:

[Donate on PayPal](https://paypal.me/martinezwilmer?country.x=DO&locale.x=es_XC)

Your generosity helps us to continue improving and maintaining this project. We appreciate every contribution, however small. Thanks for being part of our community!