https://github.com/django-fluent/fluentcms-teaser
Teaser plugin for django-fluent-contents
https://github.com/django-fluent/fluentcms-teaser
django-fluent
Last synced: 7 months ago
JSON representation
Teaser plugin for django-fluent-contents
- Host: GitHub
- URL: https://github.com/django-fluent/fluentcms-teaser
- Owner: django-fluent
- License: apache-2.0
- Created: 2015-08-29T06:34:55.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2021-11-16T16:08:08.000Z (almost 4 years ago)
- Last Synced: 2024-04-15T00:20:04.953Z (over 1 year ago)
- Topics: django-fluent
- Language: Python
- Homepage:
- Size: 50.8 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
README
fluentcms-teaser
================
.. image:: https://github.com/django-fluent/fluentcms-teaser/actions/workflows/tests.yaml/badge.svg?branch=master
:target: https://github.com/django-fluent/fluentcms-teaser/actions/workflows/tests.yaml
.. image:: https://img.shields.io/pypi/v/fluentcms-teaser.svg
:target: https://pypi.python.org/pypi/fluentcms-teaser/
.. image:: https://img.shields.io/pypi/l/fluentcms-teaser.svg
:target: https://pypi.python.org/pypi/fluentcms-teaser/
.. image:: https://img.shields.io/codecov/c/github/django-fluent/fluentcms-teaser/master.svg
:target: https://codecov.io/github/django-fluent/fluentcms-teaser?branch=master
A teaser plugin for django-fluent-contents_
Originally authored by `Basil Shubin `_.
Installation
============
First install the module, preferably in a virtual environment. It can be installed from PyPI:
.. code-block:: shell
pip install fluentcms-teaser
Backend Configuration
---------------------
First make sure the project is configured for django-fluent-contents_.
Then add the following settings:
.. code-block:: python
INSTALLED_APPS += (
'fluentcms_teaser',
)
# The upload folder for teasers
# Default: '.'
FLUENTCMS_TEASER_UPLOAD_TO = 'teasers/'
The database tables can be created afterwards:
.. code-block:: shell
python ./manage.py migrate
Now, the ``TeaserPlugin`` can be added to your ``PlaceholderField`` and
``PlaceholderEditorAdmin`` admin screens.
Frontend Configuration
----------------------
If needed, the HTML code can be overwritten by redefining ``fluentcms_teaser/teaser.html``.
Contributing
------------
If you like this module, forked it, or would like to improve it, please let us know!
Pull requests are welcome too. :-)
.. _django-fluent-contents: https://github.com/django-fluent/django-fluent-contents