Django CMS Bootstrap Grid Builder

Alla base dello sviluppo di ogni pagina web ben organizzata, esiste un unico passo base condiviso, la costruzione di una griglia. La stesura preventiva di un layout a griglia formato da containers, righe e colonne, permette di definire correttamente gli spazi assegnati a ciascun contenuto della pagina, e di mappare tali spazi per i diversi step responsive.

La creazione di una griglia, nella maggior parte dei casi, passa da una fase di disegno, spesso delegata al designer, per poi essere implementata da uno sviluppatore con l’ausilio di tecnologie web. Entrambe le fasi di creazione prevedono la conoscenza di software, linguaggi e librerie per il web, che non sempre sono di facile comprensione per chi non si occupa di sviluppo web nel proprio quotidiano.
Gli strumenti per la creazione di pagine web non offrono soluzioni abbastanza flessibili e semplici per la creazione di macrostrutture responsive simili a quanto viene sviluppato da un web developer (o spesso, non ne offrono alcuna). Peranto, chi si occupa di modificare i contenuti delle pagine web di un sito tramite dei CMS o simili, è spesso in una situazione di svantaggio, non potendo usufruire di mezzi abbastanza chiari ed intuitivi per costruire un layout responsive.
In Frankhood ci siamo posti una domanda molto semplice, che allo stesso tempo ci ha messo davanti ad una sfida estremamente stimolante:
È possibile creare uno strumento che permetta agli editor di pagine web di configurare una griglia per le proprie pagine?
Per rispondere a questa domanda, abbiamo iniziato uno studio approfondito delle tecnologie più adatte allo scopo.
Tecnologie
Immaginiamo di creare il Frontend di un plugin, che probabilmente conterrà un dato numero componenti potenzialmente annidabili, e ciascuna con delle logiche interne abbastanza complesse. Ci serve quindi una libreria o un framework che ci dia la possibilità di creare componenti in modo facile e veloce, che ci permetta di poter organizzare in maniera ordinata il nostro codice javascript, che garantisca delle ottime performance, e che data la natura del progetto (plugin) sia di facile utilizzo per progetti più piccoli, ma allo stesso tempo scalabile per garantire estendibilità al progetto.
Questa lista di requisiti sembrerebbe soddisfatta solo da tecnologie utopistiche, pensate da qualche Frontendista che sogna ad occhi aperti... e che non conosce Vue.js
Con Vue possiamo creare in pochissimo tempo tutte le componenti di cui abbiamo bisogno, annidarle e farle comunicare in modo semplice grazie al data binding e agli event handlers, possiamo mantenere organizzato il nostro codice grazie a una divisione ordinata tra Template, Script, e stili. Ci consente, inoltre, di ottimizzare il nostro codice rendendolo il più efficiente possibile, utilizzando in modo opportuno methods, computed properties, watchers, e lifecycle hooks, senza sacrificare la leggibilità.
Vue garantisce le migliori performance rispetto alle altre tecnologie Frontend maggiormente utilizzate (https://stefankrause.net/js-frameworks-benchmark8/table.html), e permette di sviluppare applicazioni di piccola o media/grande entità mantenendo un basso grado di complessità, ordine e leggibilità del codice.
Vue è stato ritenuto perfetto per raggiungere lo scopo desiderato, in quanto ci permette di raggiungere gli alti standard di qualità ed efficienza del codice che da sempre sono un requisito fondamentale per ogni progetto nato in Frankhood.
Per la definizione della griglia, e quindi delle classi con la relativa sintassi da utilizzare, è stato scelto di utilizzare Bootstrap ed il suo sistema di griglie con righe e colonne. La scelta è stata pressochè immediata vista la grande popolarità di questa libraria e la facilità nella definizione delle classi di stile che caratterizzano gli elementi delle griglia anche differenziando gli step responsive (https://getbootstrap.com/docs/4.0/layout/grid/).

Per quanto riguarda la scelta dello stack di tecnologie per il Backend, come per il Frontend, partiamo dalla scelta del linguaggio e degli eventuali framework.
Il nostro obiettivo è quello di garantire velocità, estensibilità, e facilità di implementazione, va anche considerata la necessità di avere un contesto in cui il nostro plugin deve essere inserito ed utilizzato.
Senza alcun dubbio Django CMS è la scelta migliore in questo caso, poichè ci permette di integrare nuovi plugin in modo semplice, eredita da python la velocità e la semplicità di implementazione, ed è uno dei CMS più utilizzati al mondo a livello professionale.

Con le tecnologie scelte abbiamo sviluppato il wizard per la creazione del layout a griglia, cercando di mantenere l’interfaccia essenziale e minimal,in modo da rendere l’esperienza immediata ed intuitiva per gli editor che utilizzano il CMS.

Guardando più da vicino gli elementi della griglia, è facile capire il funzionamento dei pulsanti associati, l’aggiunta e la rimozione di colonne, così come l’eliminazione di tutto l’elemento sono a portata di click per ciascuno degli elementi creati.

Dipendenze
Abbiamo gia parlato di alcune librerie e frameworks necessarie al corretto funzionamento del plugin, primo tra questi Django CMS. Si è anche accennato a Bootstrap per la costruzione della griglia tramite classi, anch’essa una dipendenza necessaria per interpretare correttamente le classi di stile che definiscono i container, le righe, e le colonne della griglia (a tutti gli step).
Ma ci sono anche altre dipendenze a librarie di terze parti necessarie per esigenze meno fondamentali, ma comunque molto importanti per il corretto funzionamento del plugin.
Un esempio sono le librerie vue-drag-drop e interactjs, utilizzate per permettere il drag and drop degli elementi all’interno dei container, ciò permette di avere un’interfaccia intuitiva per il nostro wizard di creazione del layout, assicurando una rapida curva di apprendimento anche ad utenti meno esperti.


In fase di sviluppo, per assicurare una formattazione del codice coerente, ordine, leggibilità, e manutenibilità, sono state utilizzate delle librerie come eslint e prettier, in modo da garantire codice di alta qualità, sia da parte degli sviluppatori interni a Frankhood che da parte di eventuali collaboratori esterni in futuro.
Comunicazione
Arrivati a questo punto abbiamo definito chiaramente quali sono le tecnologie utilizzate per lo sviluppo del plugin, ma come possiamo comunicare le informazioni riguardanti la struttura della griglia dal Frontend al Backend per essere tradotte in una serie di strutture popolabili attraverso il CMS?
La risposta è ovvia, JSON.
Utilizzando il formato JSON possiamo facilmente serializzare le informazioni riguardanti la griglia al momento del salvataggio, ed inviarle dal Frontend al Backend con facilità. Tramite l’annidamento possiamo replicare il layout scelto, e assegnare tutte le proprietà di cui abbiamo bisogno su ciascun elemento, comprese le proprietà che andranno poi a definire le classi css necessarie a bootstrap per costruire la griglia in pagina.
Una volta che queste informazioni, in formato JSON, arrivano al backend, vengono interpretate in modo tale da costruire la griglia desiderata tramite il CMS, tale griglia sarà quindi modificabile e popolabile, e rispetterà la configurazione indicata al momento della creazione (a meno di modifiche postume, tramite il cms).


Rilascio
Terminato lo sviluppo utilizzando lo stack tecnologico descritto nei paragrafi precedenti, il pacchetto è stato rilasciato su github, disponibile per l’utilizzo e/o per la collaborazione da parte di terzi.
Il pacchetto può essere raggiunto al seguente link:
https://github.com/frankhood/django-cms-bootstrap-grid-builder
All’interno della repo indicata, è stata aggiunta anche una documentazione dettagliata, con linee guida per l’utilizzo del pacchetto e per inviare modifiche e nuove features tramite merge request.
Missione compiuta!
Non ci resta che utilizzare questo nuovo strumento per renderci la vita facile ogni volta che avremo bisogno di fornire un wizard intuitivo per la creazione di griglie agli editor del nostro sito!