Repository files navigation

django CMS Frontend is a versatile plugin suite for django CMS that facilitatesthe easy creation of reusable frontend components. It supports any CSS framework,allowing developers to seamlessly integrate their preferred styling libraries.For immediate use, it includes a comprehensive set of Bootstrap 5 componentsand templates.

• Effortless Development of Custom Components: Create reusable frontendcomponents with ease, utilizing simple templates and declarative formclasses. These components can function both as CMS plugins and withinstandard Django templates. ​
• Framework-Agnostic Design: Maintain flexibility in your project's designby decoupling plugins from specific versions of a CSS framework. This ensuresthat updating frameworks in the future doesn't necessitate rebuilding yoursite's plugin structure. ​
• Built-in Bootstrap 5 Components: Access a ready-to-use collectionof Bootstrap 5 components, streamlining the process of building responsiveand modern interfaces. ​
• Extensibility: Enhance your project by creating custom components withminimal code. The system is designed to be extended both within individualprojects and through separate theme applications. ​
• Consistent User Experience: Utilize plugins as UI components throughoutyour project, promoting a cohesive and uniform user interface. ​

Designed to be framework-agnostic, django CMS Frontend allows developers toselect and change CSS frameworks by adjusting project settings, eliminatingthe need to reconstruct the CMS plugin tree when upgrading or switchingframeworks. It leveragesdjango-entangled to store design parameters ina common JSON field, preventing database bloat and facilitating seamlessupdates to frontend features.

By providing a suite of Bootstrap 5-based components for layout structuring,including grids, components, and forms, django CMS Frontend simplifies theprocess of building responsive and structured page designs. Developers canalso create custom components with minimal code, ensuring a consistent andefficient development experience.

It is up to you which (if any at all) pre-built components you want to includein your project. Each set of components is a separate package you can includein your project'sINSTALLED_APPS.

Because this is a an open-source project, we welcome everyone toget involved in the project andreceive 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 yourfeedback in the form of issues and pull requests. Before submitting yourpull request, please review ourcontribution guidelines.

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

We're grateful to all contributors who have helped create and maintainthis package. Contributors are listed at thecontributorssection.

One of the easiest contributions you can make is helping to translate this addon onTransifex.

SeeREQUIREMENTS in thesetup.pyfile for additional dependencies:

• django-cms, version 3.11 or later
• django-filer, version 1.7 or later
• djangocms-attributes-field, version 1.0 or later
• djangocms-text
• djangocms-link
• django-entangled 0.6 or later

Make suredjango Filer anddjango CMS Text /django CMS Text CKEditor are installed andconfigured appropriately.

As of djangocms-frontend 2.0, djangocms-link is needed to use the Link/Button plugin.

For a manual install:

• runpip install djangocms-frontend

• add the following entries to yourINSTALLED_APPS (or only those you need):

  'easy_thumbnails','djangocms_link',  # Needed for link support# Base package template components and custom components'djangocms_frontend',# Add built-in Bootstrap 5 components as needed'djangocms_frontend.contrib.accordion',  # optional'djangocms_frontend.contrib.alert',  # optional'djangocms_frontend.contrib.badge',  # optional'djangocms_frontend.contrib.card',  # optional'djangocms_frontend.contrib.carousel',  # optional'djangocms_frontend.contrib.collapse',  # optional'djangocms_frontend.contrib.content',  # optional'djangocms_frontend.contrib.grid',  # optional'djangocms_frontend.contrib.icon',  # optional'djangocms_frontend.contrib.image',  # optional'djangocms_frontend.contrib.jumbotron',  # optional'djangocms_frontend.contrib.link',  # optional'djangocms_frontend.contrib.listgroup',  # optional'djangocms_frontend.contrib.media',  # optional'djangocms_frontend.contrib.tabs',  # optional'djangocms_frontend.contrib.utilities',  # optional

• runpython manage.py migrate

djangocms-frontend has a weak dependencies ondjangocms-icon you caninstall separately or by adding an option:

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

See readthedocs for thedocumentation.

SeeLICENSE.