Skip to main content

Adds abstract User Interface items as plugins to django CMS.

Project description

pypi Documentation Status coverage python django djangocms djangocms4

django CMS Frontend is a plugin bundle which builds on and improves the architecture of djangocms-bootstrap4. Its objective is to provide a set of popular frontend components independent of the currently used frontend framework such as Bootstrap, or its specific version.

preview.png

Key features

  • Support of Bootstrap 5, django CMS 3.8+ and the new upcoming major django CMS 4.

  • Separation of plugins from css framework, i.e. no need to rebuild you site’s plugin tree if css framework is changed in the future, e.g. from Bootstrap 5 to a future version.

  • New link plugin allowing to link to internal pages provided by other applications, such as djangocms-blog.

  • Nice and well-arranged admin frontend of djangocms-bootstrap4

  • A management command to migrate from djangocms-bootstrap4. This command automatically migrates all djangocms-bootstrap4 plugins to djangocms-frontend.

  • Extensible within the project and with separate project (e.g. a theme app)

Description

The plugins are framework agnostic and the framework can be changed by adapting your project’s settings. Also, it is designed to avoid having to rebuild your CMS plugin tree when upgrading e.g. from one version of your frontend framework to the next.

django CMS Frontend uses django-entangled by Jacob Rief to avoid bloating your project’s database with css framework-dependent tables. Instead all design parameters are stored in a common JSON field and future releases of improved frontend features will not require to rebuild your full plugin tree.

The link plugin has been rewritten to not only allow internal links to other CMS pages, but also to other django models such as, e.g., posts of djangocms-blog.

Contributing

Because this is a an open-source project, we welcome everyone to get involved in the project and receive a reward for their contribution. Become part of a fantastic community and help us make django CMS the best CMS in the world.

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.

The project makes use of git pre-commit hooks to maintain code quality. Please follow the installation steps to get pre-commit setup in your development environment.

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.

Requirements

See REQUIREMENTS in the setup.py file for additional dependencies:

  • django-cms, version 3.7 or later

  • django-filer, version 1.7 or later

  • djangocms-attributes-field, version 1.0 or later

  • djangocms-text-ckeditor, version 3.1 or later

  • django-select2

  • django-entangled

Make sure django Filer and django CMS Text CKEditor are installed and configured appropriately.

Installation

For a manual install:

  • run pip install djangocms-frontend

  • add the following entries to your INSTALLED_APPS:

    'easy_thumbnails',
    'djangocms_frontend',
    'djangocms_frontend.contrib.accordion',
    'djangocms_frontend.contrib.alert',
    'djangocms_frontend.contrib.badge',
    'djangocms_frontend.contrib.card',
    'djangocms_frontend.contrib.carousel',
    'djangocms_frontend.contrib.collapse',
    'djangocms_frontend.contrib.content',
    'djangocms_frontend.contrib.grid',
    'djangocms_frontend.contrib.icon',
    'djangocms_frontend.contrib.image',
    'djangocms_frontend.contrib.jumbotron',
    'djangocms_frontend.contrib.link',
    'djangocms_frontend.contrib.listgroup',
    'djangocms_frontend.contrib.media',
    'djangocms_frontend.contrib.tabs',
    'djangocms_frontend.contrib.utilities',
  • run python manage.py migrate

If you use Django < 3.2 please also add django-jsonfield-backport to your requirements.txt and django_jsonfield_backport to your INSTALLED_APPS list.

djangocms-frontend has a weak dependencies on djangocms-icon you can install separately or by adding an option:

pip install djangocms-frontend[djangocms-icon]  # Installs djangocms-icon for icon support in links

Documentation

See readthedocs for the documentation.

License

See LICENSE.

Download files

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

Source Distribution

djangocms-frontend-1.2.2.tar.gz (4.4 MB view details)

Uploaded Source

Built Distribution

djangocms_frontend-1.2.2-py3-none-any.whl (4.6 MB view details)

Uploaded Python 3

File details

Details for the file djangocms-frontend-1.2.2.tar.gz.

File metadata

  • Download URL: djangocms-frontend-1.2.2.tar.gz
  • Upload date:
  • Size: 4.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for djangocms-frontend-1.2.2.tar.gz
Algorithm Hash digest
SHA256 6c2392a9c87089d0a001a029e6d8aed6df527444b74e534406482794175fe8ae
MD5 4653a89ffeb68b08a4ec1517bc8cf07c
BLAKE2b-256 2ac3da389fbd9cfd93341930aaf1a7ae047272370a152c201eb0e1a9260ff035

See more details on using hashes here.

File details

Details for the file djangocms_frontend-1.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for djangocms_frontend-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 78addc467c7091940bbdde1f8984f2fb96133dd5589fa158d1a3d0852071ab2d
MD5 7080ac7f7e64ceab52718d3d5587e4d1
BLAKE2b-256 1ada37d744e1585c291bb766cd24329e722d131ec4ef4594c6daa12ca90209fa

See more details on using hashes here.

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