Mettre en place un styleguide dans un projet Django

Chez Naeka, nous avons une affection particulière pour les projets complexes. Un styleguide est donc devenu une nécessité dans de nombreux aspects du développement et de la maintenance de nos applications web. Nous l'utilisons pour les raisons suivantes :

  • ça facilite la communication équipe/équipe et client/équipe,
  • ça liste les composants ré-utilisables de l'application,
  • ça permet de garder une cohérence de l'interface dans notre projet,
  • ça simplifie le développement de nouvelles vues HTML/CSS,
  • ça nous force à standardiser notre code.

Mise en place

Nous créons une URL dans Django pour notre styleguide :

Nous obtenons une URL http://localhost:8000/styleguide accessible en environnement de développement (lorsque DEBUG=True) qui nous permet de visualiser le styleguide depuis le navigateur. Ensuite, nous créons un fichier styleguide.html dans le répertoire de nos templates contenant le code suivant :

Ensuite, nous plaçons notre propre fichier CSS à la place des lignes suivantes :

C'est tout !

Comment ça marche ?

Le code HTML présenté ci-dessus est personnalisé en fonction du projet. Les classes CSS préfixées par …