django-tours

Introducción a django-tours: Agregando Recorridos Interactivos a tu Proyecto Django.

Esta herramienta está diseñada para facilitar la incorporación de recorridos interactivos en tus proyectos Django utilizando shepherdjs.

¿Qué es django-tours?

django-tours es una aplicación Django que simplifica la incorporación de recorridos interactivos a tu aplicación web. Con esta herramienta, puedes guiar a los usuarios a través de diferentes partes de tu sitio web, proporcionando explicaciones detalladas y resaltando características clave.

Instalación

La instalación es rápida y sencilla. Solo necesitas ejecutar el siguiente comando:

pip install django-tours

Uso

Agregar a las Aplicaciones Instaladas

En tu archivo settings.py, asegúrate de agregar ‘tours‘ a la lista de aplicaciones instaladas:

# settings.py

INSTALLED_APPS = [
    # …
    'tours',
    # …
]

Configuración Opcional:

Si deseas establecer variables predeterminadas, puedes agregar lo siguiente en tu archivo settings.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'

Agregar las URLs

En tu archivo urls.py, agrega las URLs de la aplicación tours:

urlpatterns = [
    # …
    path('tours/', include('tours.urls')),
    # …
]

Ejecutar las Migraciones

Asegúrate de aplicar las migraciones para incorporar las nuevas tablas en la base de datos:

python manage.py migrate

Cargar Recorridos en la Plantilla

En tus plantillas Django, puedes cargar fácilmente los recorridos con el siguiente código:

{% load tours %}
{% load_tours request %}

Contribución 💗

Si encuentras valor en este proyecto y deseas mostrar tu apoyo, considera realizar una donación a través de PayPal:

Donar en PayPal

Tu generosidad nos ayuda a seguir mejorando y manteniendo este proyecto. Apreciamos cada contribución, por pequeña que sea. ¡Gracias por ser parte de nuestra comunidad!

Espero que django-tours sea una adición útil a tus proyectos Django. ¡Explora, disfruta y mejora la experiencia de usuario en tu aplicación web!