djangocms-slick-slider 0.9.3

A Django CMS Slider Plugin with Slick

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

Admin Form

Output

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:

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: admin Password: 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

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

Release to PyPi

In the project root, run:

bump2version patch|minor|major
make release

Credits

Tools used in rendering this package:

• Cookiecutter

• cookiecutter-djangopackage

• Slick Slider

ToDos

• make slider respect the order of SlickSliderImage Plugins

• add more styling options to plugin

• translations