https://github.com/django-cms/djangocms-bootstrap5
django CMS Bootstrap 5 is a plugin bundle for django CMS providing several components from the popular Bootstrap 5 framework.
https://github.com/django-cms/djangocms-bootstrap5
Last synced: 2 months ago
JSON representation
django CMS Bootstrap 5 is a plugin bundle for django CMS providing several components from the popular Bootstrap 5 framework.
- Host: GitHub
- URL: https://github.com/django-cms/djangocms-bootstrap5
- Owner: django-cms
- License: other
- Created: 2021-11-11T10:20:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-31T14:18:39.000Z (over 2 years ago)
- Last Synced: 2025-04-14T04:16:10.910Z (2 months ago)
- Language: Python
- Homepage: https://django-cms.org
- Size: 169 KB
- Stars: 5
- Watchers: 2
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
Awesome Lists containing this project
README
======================
django CMS Bootstrap 5 (WIP)
======================
|pypi| |build| |coverage|
**django CMS Bootstrap 5** is a plugin bundle for django CMS providing several
components from the popular `Bootstrap 5 `_ library.
.. note::
This project is endorsed by the `django CMS Association `_.
That means that it is officially accepted by the dCA as being in line with our roadmap vision and development/plugin policy.
Join us on `Slack `_.
.. image:: preview.gif
Contributing
============
This is a an open-source project. We'll be delighted to receive your
feedback in the form of issues and pull requests. Before submitting your
pull request, please review our `contribution guidelines
`_.
We're grateful to all contributors who have helped create and maintain this package.
Contributors are listed at the `contributors `_
section.
One of the easiest contributions you can make is helping to translate this addon on
`Transifex `_.
Documentation
=============
See ``REQUIREMENTS`` in the `setup.py `_
file for additional dependencies:
|python| |django| |djangocms|
* Django Filer 1.7 or higher
* Django Text CKEditor 3.1 or higher
Make sure `django Filer `_
and `django CMS Text CKEditor `_
are installed and configured appropriately.
Installation
------------
For a manual install:
* run ``pip install djangocms-bootstrap5``
* add the following entries to your ``INSTALLED_APPS``::
'djangocms_icon',
'djangocms_link',
'djangocms_picture',
'djangocms_bootstrap5',
'djangocms_bootstrap5.contrib.bootstrap5_alerts',
'djangocms_bootstrap5.contrib.bootstrap5_badge',
'djangocms_bootstrap5.contrib.bootstrap5_card',
'djangocms_bootstrap5.contrib.bootstrap5_carousel',
'djangocms_bootstrap5.contrib.bootstrap5_collapse',
'djangocms_bootstrap5.contrib.bootstrap5_content',
'djangocms_bootstrap5.contrib.bootstrap5_grid',
'djangocms_bootstrap5.contrib.bootstrap5_jumbotron',
'djangocms_bootstrap5.contrib.bootstrap5_link',
'djangocms_bootstrap5.contrib.bootstrap5_listgroup',
'djangocms_bootstrap5.contrib.bootstrap5_media',
'djangocms_bootstrap5.contrib.bootstrap5_picture',
'djangocms_bootstrap5.contrib.bootstrap5_tabs',
'djangocms_bootstrap5.contrib.bootstrap5_utilities',
* run ``python manage.py migrate``
Configuration
-------------
django CMS Bootstrap 5 **utilises** the following django CMS plugins:
* **django CMS Link**: `Link `_
* **django CMS Picture**: `Picture `_
* **django CMS Icon**: `Icon `_
It provides the following **standard** Bootstrap 5 components:
* `Alerts `_
* `Badge `_
* `Card `_
* `Carousel `_
* `Collapse `_
* `Content (Blockquote, Code, Figure) `_
* `Grid (Container, Row, Column) `_
* `Jumbotron `_
* `Link / Button `_
* `List group `_
* `Media `_
* `Picture / Image `_
* `Tabs `_
* `Utilities (Spacing) `_
django CMS Bootstrap 5 **does not** add the styles or javascript files to your frontend, these need to be added at your discretion.
Settings
~~~~~~~~
There are various settings possible on django CMS Bootstrap 5, to restrict them
for now only the following can be changed::
DJANGOCMS_BOOTSTRAP5_TAG_CHOICES = ['div', 'section', 'article', 'header', 'footer', 'aside']
DJANGOCMS_BOOTSTRAP5_CAROUSEL_TEMPLATES = (
('default', _('Default')),
)
DJANGOCMS_BOOTSTRAP5_GRID_SIZE = 12
DJANGOCMS_BOOTSTRAP5_GRID_CONTAINERS = (
('container', _('Container')),
('container-fluid', _('Fluid container')),
)
DJANGOCMS_BOOTSTRAP5_GRID_COLUMN_CHOICES = (
('col', _('Column')),
('w-100', _('Break')),
('', _('Empty'))
)
DJANGOCMS_BOOTSTRAP5_USE_ICONS = True
DJANGOCMS_BOOTSTRAP5_TAB_TEMPLATES = (
('default', _('Default')),
)
DJANGOCMS_BOOTSTRAP5_SPACER_SIZES = (
('0', '* 0'),
('1', '* .25'),
('2', '* .5'),
('3', '* 1'),
('4', '* 1.5'),
('5', '* 3'),
)
DJANGOCMS_BOOTSTRAP5_CAROUSEL_ASPECT_RATIOS = (
(16, 9),
)
DJANGOCMS_BOOTSTRAP5_COLOR_STYLE_CHOICES = (
('primary', _('Primary')),
('secondary', _('Secondary')),
('success', _('Success')),
('danger', _('Danger')),
('warning', _('Warning')),
('info', _('Info')),
('light', _('Light')),
('dark', _('Dark')),
('custom', _('Custom')),
)
Please be aware that this package does not support djangocms-text-ckeditor's
`Drag & Drop Images `_
so be sure to set ``TEXT_SAVE_IMAGE_FUNCTION = None``.
Running Tests
-------------
You can run tests by executing::
virtualenv env
source env/bin/activate
pip install -r tests/requirements.txt
python setup.py test
To run the frontend make sure to use **node 10.x**.
.. |pypi| image:: https://badge.fury.io/py/djangocms-bootstrap5.svg
:target: http://badge.fury.io/py/djangocms-bootstrap5
.. |build| image:: https://travis-ci.org/divio/djangocms-bootstrap5.svg?branch=master
:target: https://travis-ci.org/divio/djangocms-bootstrap5
.. |coverage| image:: https://codecov.io/gh/divio/djangocms-bootstrap5/branch/master/graph/badge.svg
:target: https://codecov.io/gh/divio/djangocms-bootstrap5
.. |python| image:: https://img.shields.io/badge/python-3.5+-blue.svg
:target: https://pypi.org/project/djangocms-bootstrap5/
.. |django| image:: https://img.shields.io/badge/django-2.2,%203.0,%203.1-blue.svg
:target: https://www.djangoproject.com/
.. |djangocms| image:: https://img.shields.io/badge/django%20CMS-3.7%2B-blue.svg
:target: https://www.django-cms.org/