https://github.com/mathison-ag/djangocms-slick-slider

https://github.com/mathison-ag/djangocms-slick-slider

django djangocms slickslider slider-plugin

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/mathison-ag/djangocms-slick-slider
• Owner: Mathison-AG
• License: mit
• Created: 2017-10-12T12:31:59.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-01-01T13:10:34.000Z (about 1 year ago)
• Last Synced: 2024-10-07T08:11:16.826Z (4 months ago)
• Topics: django, djangocms, slickslider, slider-plugin
• Language: JavaScript
• Homepage: https://mathison.ch
• Size: 814 KB
• Stars: 4
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

        
==============================

Django CMS Slick Slider Plugin

==============================

.. image:: https://badge.fury.io/py/djangocms-slick-slider.svg

    :target: https://badge.fury.io/py/djangocms-slick-slider

.. image:: https://travis-ci.org/oesah/djangocms-slick-slider.svg?branch=master

    :target: https://travis-ci.org/oesah/djangocms-slick-slider

.. image:: https://codecov.io/gh/oesah/djangocms_slick_slider/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/oesah/djangocms_slick_slider

A Django CMS Slider Plugin with `Slick Slider `_.

Features

--------

* Add a Slick Slider to any page via Django CMS Plugin

* Change/set Slick options via ``JSONField``

* Set some styling options such as color

**CMS**

.. image:: docs/media/admin.png

   :alt: alternate text

   :align: right

**Admin Form**

.. image:: docs/media/admin_form.png

   :alt: alternate text

   :align: right

**Output**

.. image:: docs/media/slider.png

   :alt: alternate text

   :align: right

Documentation

-------------

The full documentation is at https://djangocms-slick-slider.readthedocs.io.

Quickstart

----------

Install djangocms_slick_slider::

    pip install djangocms-slick-slider

Add it to your `INSTALLED_APPS`:

.. code-block:: python

    INSTALLED_APPS = (

        ...

        'djangocms_slick_slider.apps.DjangocmsSlickSliderConfig',

        ...

    )

Example project

---------------

You can quickly get an example project up to test / develop the plugin.

If you have virtualenvwrapper installed::

    git clone https://github.com/oesah/djangocms_slick_slider.git

    cd example

    mkvirtualenv my_project_env

    pip install -r requirements.txt

    python manage.py runserver

Visit your homepage (usually http://localhost:8000).

User: :code:`admin`

Password: :code:`adminadmin`

You should see some instances of the ``Slick Slider`` plugin. You can play around

to see, how it works.

Settings

--------

``SLICK_SLIDER_VERSION``

^^^^^^^^^^^^^^^^^^^^^^^^

Version of Slick Slider that should be used. Keep in mind, that this version

needs to be in ``static/vendor/`` folder with the appropriate folder name.

If you want to upgrade, download and copy the new version into the before

mentioned folder and change the version in the settings.

Default: ``1.8.0``

``SLICK_SLICKER_DEFAULT_OPTIONS``

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can adjust the default options by setting ``SLICK_SLICKER_DEFAULT_OPTIONS`` to a dictionary.

Default::

    SLICK_SLICKER_DEFAULT_OPTIONS = {

        'dots': True,

        'slidesToShow': 2,

        'mobileFirst': False,

        'slidesToScroll': 1,

        'autoplay': True,

        'autoplaySpeed': 1500

    }

You can set any option that slick-slider offers. You can find them here: https://kenwheeler.github.io/slick/

``SLICK_SLIDER_ACE_THEME``

^^^^^^^^^^^^^^^^^^^^^^^^^^

You can change the ACE theme of the edit field in the admin.

Default: ``json``

``SLICK_SLIDER_ACE_MODE``

^^^^^^^^^^^^^^^^^^^^^^^^^

You can change the ACE mode of the edit field in the admin.

Default: ``github``

Running Tests

-------------

Does the code actually work?

::

    source /bin/activate

    (myenv) $ pip install tox

    (myenv) $ tox

If you have issues with different python versions, please take a look at

these docs: https://www.holger-peters.de/using-pyenv-and-tox.html

Release to PyPi

---------------

For versioning, you need to have `standard-version` installed::

    yarn install

Once you are ready and everything has been commited to git, you can run::

    yarn run release

This will:

* Bump the version in the according files

* Commit everything to git and create a git tag

* Create a package for PyPi and upload it

* Push everything to Git including tags

Credits

-------

Tools used in rendering this package:

*  Cookiecutter_

*  `cookiecutter-djangopackage`_

*  `Slick Slider`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage

.. _`Slick Slider`: http://kenwheeler.github.io/slick/

ToDos

-----

* translations

Sponsorship

-----------

This project is maintained by `Mathison AG | Mobile & Web Development `_.

Used by

-------

* `Stella Gastro | The best Restaurants, Bars and Cafés in Switzerland `_.

* `Lancer Express | The Swiss Army Knife for Freelancers `_.