Alex d'or 2019-2022

Construire collaborativement le nouveau site des Alex d'or.

Ce projet utilise les frameworks Laravel et Vue.

Installation

(A déplacer dans INSTALLATION.md.)

# Cloner le dépot
git clone [email protected]:alexdor-rpgmaker/rodexal.git

# Installer les dépendances Composer
composer install

# Installer les dépendances NPM
npm install

Il faut avoir une instance mysql active, et se créer deux bases de données : rodexal et rodexal_test. (Voir une documentation mysql si besoin.)

Il faut ensuite créer et remplir le fichier .env sur la base du fichier .env.example, notamment les informations concernant la base de données (DB_DATABASE, DB_USERNAME, DB_PASSWORD, ...). Faire de même pour le fichier .env.dusk (utilisé par les tests de navigateur).

# Lancer les migrations de base de données
php artisan migrate

# Ajouter des fausses données dans la base de données
php artisan db:seed

Développement

(A déplacer dans CONTRIBUTING.md.)

Lancement du serveur

• Sur Windows, il est conseillé d'utiliser Wamp.
• Sur Mac, il est conseillé d'utiliser Valet.

Compilation des assets

# Lancer dans un autre terminal
npm run dev

# Sinon pour que la compilation se fasse en continu
npm run watch

# Sinon pour compiler et minifier les assets avant mise en production
npm run production

Lancement des tests unitaires frontend

# Lancer les tests
npm run test

# Lancer les tests en continu
npm run test:watch

Lancement des tests unitaires backend

# Lancer les tests
composer test

# Lancer les tests juste pour la classe BBCode (par exemple)
composer test -- --filter BBCode

# Lancer les tests en continu
composer test:watch

Lancement des tests de navigateur

Le paramétrage des tests de navigateur se fait dans le fichier .env.dusk, notamment le nom de la base de données (DB_DATABASE=rodexal_test) qui est différent, pour éviter la suppression de données en local. Il contient aussi DUSK=true.

# Lancer les tests
composer test:e2e

S'il y a une erreur de type session not created: Chrome version must be between 70 and 73, lancer cette commande :

php artisan dusk:chrome-driver

S'il y a une erreur de type session not created: This version of ChromeDriver only supports Chrome version XX, il faut mettre à jour votre Chrome à la version XX. :) (Et parfois relancer la commande ci-dessus.)

Dépendances

Nous utilisons Vue 2, pas encore migré vers Vue 3. Cela implique :

• Vue-loader version 15 max
• Vue-test-utils version 1 max

Politique de Contribution

Voir CONTRIBUTING.md.

Mise en production

Voir DEPLOY.md.