FrancoisGuillem / pbf

Site du Paris Beer Festival
1 stars 1 forks source link

WordPress x Paris Beer Festival

Ce projet contient un plugin WordPress pour le site du Paris Beer Festival et le thème correspondant.

Que fait le plugin ?

Il définit deux types de contenus personnalisés :

Et le Thème?

Le thème est basé sur un thème Boostrap basique avec les modifications suivantes:

Les fonctions php personnalisées utilisées dans ces fichiers sont définies dans le fichier inc/pbf_functions.php. Le css personnalisé se trouve soit directement dans les fichiers ci-dessus, soit à la fin du fichier style.css.

Tester en local

Le plus simple pour tester en local le plugin et le thème est d'utiliser docker-compose. Cela permet de configurer en 10 secondes une base de données, un serveur web et WordPress de façon compartimentée. Aucun risque de casser quelque chose sur votre ordinateur ! Si vous ne l'avez pas déjà fait, installez d'abord docker.

Il vous faudra configurer les variables d'environnement suivantes:

Nom de variables Valeur
MYSQL_ROOT_PASSWORD mot de passe MySQL maitre
WORDPRESS_DB_USER utilisateur base de données
WORDPRESS_DB_PASSWORD mot de passe de l'utilisateur
GMAP_API_KEY Clée permettant d'utiliser l'API de Google Maps. Vous pouvez en obtenir une ici

Vous pouvez rentrer n'importe quoi pour les trois premières variables. Par contre, la dernière doit être configurée correctement si vous voulez tester le géocodage des adresses et l'affichage des cartes (mais ce n'est pas obligatoire).

Sur Windows

Vous pouvez utiliser le menu "Modifier les variables d'environnement" (Pour le trouver facilement, cherchez "variable" dans le champ de recherche de la barre de tache). Vous devrez ensuite redémarrer.

Sur Mac et Linux

Pour les enregistrer une bonne fois pour toutes, vous pouvez modifier le fichier "~/.bashrc" et rajouter les lignes

export MYSQL_ROOT_PASSWORD=motdepasseroot
export WORDPRESS_DB_USER=monutilisateur
export WORDPRESS_DB_PASSWORD=motdepasse
export GMAP_API_KEY=XXXXXXXX

Pour prendre en compte les modifications sans redémarrer, vous pouvez lancer dans un terminal la commande suivante:

source ~/.bashrc

Une fois les variables d'environnement définies, clonez ce dépot puis dans un terminal mettez vous dans le dossier du projet puis lancez la commande :

docker-compose up -d

Maintenant dans un navigateur, ouvrez la page http://localhost:8000 pour procéder à l'installation de Wordpress en local. Dans la page des extensions, activez tous les plugins disponibles, puis dans les thèmes activez le thème "pbf".

Développer en local

Pour développer en local vous avez besoin de nodejs en version supérieure ou égale à 10 ainsi que gulp-cli installé en global (npm i gulp-cli -g).

Un fois nodejs et gulp-cli d'installé, mettez-vous dans le dossier du projet et lancez la commande suivante pour installer les dépendances :

npm install

Pour commencer à travailler, toujours dans le répertoire du projet, lancer la commande :

npm run dev

Cela lancera la compilation des assets puis un watcher pour recompiler les fichiers .scss ainsi qu'un serveur à l'adresse http://localhost:3000 avec live reload à chaque modification des fichiers .scss et .php