Skip to main content

A Django CMS Slider Plugin with Slick

Project description

=============================
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 <http://kenwheeler.github.io/slick/>`_.

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 migrate
python manage.py createsuperuser
python manage.py runserver

Afterwards, you can login and create a first page on which you can
use the ``Slick Slider`` plugin.


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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ToDo

SLICK_SLIDER_ACE_THEME
^^^^^^^^^^^^^^^^^^^^^^

ToDo

SLICK_SLIDER_ACE_MODE
^^^^^^^^^^^^^^^^^^^^^

ToDo

Running Tests
-------------

Does the code actually work?

::

source <YOURVIRTUALENV>/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

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
-----

* make slider respect the order of ``SlickSliderImage`` Plugins
* add more styling options to plugin
* translations





History
-------

0.2.4 (2017-10-13)
++++++++++++++++++

* fixed jsonfield default error due to encoding


0.2.2 (2017-10-13)
++++++++++++++++++

* bug fixes that caused whitenoise to crash due to relative paths


0.2.1 (2017-10-13)
++++++++++++++++++

* bug fixes that cause the slider not to show up
* better python 3 compatibility

0.2.0 (2017-10-13)
++++++++++++++++++

* major database change
* fixed many bugs
* you need to completey delete the old db and use the new one


0.1.4 (2017-10-13)
++++++++++++++++++

* changed structure of settings


0.1.2 (2017-10-13)
++++++++++++++++++

* added django-cms as dependency to pypi package (setup.py)


0.1.1 (2017-10-12)
++++++++++++++++++

* fixed github link in setup.py

0.1.0 (2017-10-12)
++++++++++++++++++

* First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

djangocms-slick-slider-0.3.2.tar.gz (45.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page