Wankul Builder

Technologies utilisées

PHP 8.2
Node 20
Laravel 10
MariaDB
InertiaJS
Vue.js
TailwindCSS
Mailpit
Laravel Pint
Husky
Commitizen

Installation du projet

Avec Docker (Sail)

Récupération du projet :

git clone git@github.com:romainrhd/wankul-builder.git

On se déplace dans le projet :
```
cd wankul-builder/
```
On crée le fichier .env et on le remplit avec les bonnes informations :
```
cp .env.example .env
```
Il faut bien penser à mettre à jour les valeurs suivantes :
- LOG_CHANNEL (Mettre daily pour avoir un fichier de log par jour)

Installation des dépendances :

docker run --rm \
-u "$(id -u):$(id -g)" \
-v "$(pwd):/var/www/html" \
-w /var/www/html \
laravelsail/php82-composer:latest \
composer install --ignore-platform-reqs

Installation de la base de données :
```
sail artisan migrate --seed
```
Création du lien symbolique pour les images :
```
sail artisan storage:link
```
Création du lien symbolique pour les images :
```
sail artisan key:generate
```
Installation des dépendances front :
```
sail npm install
```
Lancement du projet :
```
sail npm run dev
```

Sans Docker

Récupération du projet :

git clone git@github.com:romainrhd/wankul-builder.git

On se déplace dans le projet :
```
cd wankul-builder/
```
On crée le fichier .env et on le remplit avec les bonnes informations :
```
cp .env.example .env
```
Il faut bien penser à mettre à jour les valeurs suivantes :
- LOG_CHANNEL (Mettre daily pour avoir un fichier de log par jour)
Installation des dépendances :
```
composer install
```
Installation de la base de données :
```
php artisan migrate --seed
```
Création du lien symbolique pour les images :
```
php artisan storage:link
```
Création de la clé Laravel :
```
php artisan key:generate
```
Installation des dépendances front :
```
npm install
```
Lancement du projet :
```
npm run dev
```

Informations utiles

Récupération de l'intégralité des images des cartes :

J'ai également développé un scrapper qui va remplir la base de données avec les images des cartes, leur id et leur nom. Il est disponible ici : https://github.com/romainrhd/wankul-scrapper

Formatage du code :

./vendor/bin/pint -v

Hooks Git avec Husky

Utilisation de Husky pour ajouter des hooks à Git.

Commitlint : permet d'ajouter des conventions pour les messages de commit.
Laravel Pint : permet de formater le code juste avant de créer le commit.

Commitizen

Commitizen est un outil qui sert d'aide à la rédaction d'un message de commit pour respecter les conventions du commitlint. C'est surtout utile lors de l'onboarding d'un développeur sur un projet.

Pour l'utiliser, il suffit d'ajout au stage ses modifications puis de taper la commande cz à la place de lancer la commande git commit -m "mon message". Commitizen va alors dialoguer avec le développeur en ligne de commande pour l'aider à rédiger son message de commit.