Guide d'installation

RESAC- Guide d'installation

🏁 Prérequis

Consulter la page de la Généralité pour avoir une idée générale sur le fonctionnement de RESAC et sur les technologies utilisées.

Pour installer RESAC il est impératif d’avoir :

• Un environnement de développement PHP intégrant :

  • Un SBGD MySQL
  • PHP >= 8.0

• Composer - Pour la gestion des dépendances PHP

• NodeJS - Pour le serveur CDN

NB: Nous recommandons l'utilisation de Laragon (avec PhpMyAdmin) ou WampServer comme environnement de développement PHP.

Installation & configuration

1. Serveur PHP - RESAC
2. Serveur CDN - RESAC CDN

Avant tout, créer un dossier parent dans lequel se trouvera l'ensemble du projet.

mkdir RESAC
cd RESAC

Structure final du dossier

.
├── RESAC              # Dossier du projet
│   ├── RESAC          # Dossier du serveur web     
│   └── RESAC-CDN      # Dossier du serveur CDN
└── ...

🌍 Serveur Web PHP - RESAC

Placer vous dans le dossier parent du projet puis exécuter la commande

git clone https://github.com/jdjebi/RESAC.git

NB: Eviter de travailler sur la branche master car c'est elle qui est utilisée pour les déploiements. Assurer vous donc de travailler sur une branche.

Une fois le téléchargement terminé, installer les dépendances PHP et exécutez un composer dump-auload

cd RESAC
composer install
composer dump-autoload

Passons à la configuration.

Configuration

1. Créer une base de données (Par défaut RESAC WEB en local est configuré pour utiliser une base de données du nom de youniti)

2. Créer la table de la base de données

Vous avez deux options:

• Importer le fichier database/local_database/db_v3.sql dans votre de données, cela chargera toutes les tables principales mais ne prend pas en compte les derniers changements (Non recommandé)
• Exécuter la commande php artisan migrate, Cette méthode est plus souple car elle prend en charge les changements les plus récents (Très recommandé)

3. Configurer les accès à votre base de données dans fichier .env à la racine du projet.

   DB_DATABASE=<nom base de données> // youniti par défaut
   DB_USERNAME=root
   DB_PASSWORD=

4. Si vous souhaitez utiliser la fonctionnalité du mot de passe oublié, configurer les accès à d'un compte Mailtrap

   MAIL_DRIVER=smtp
   MAIL_HOST=smtp.mailtrap.io
   MAIL_PORT=2525
   MAIL_USERNAME=
   MAIL_PASSWORD=

5. Exécuter la commande php artisan db:seed pour charger données en rapport avec le système de rôle et permission

A ce stade vous pouvez démarrer le serveur !

NB: Vous pouvez ignorer les autres configurations. Elles ne sont pas toutes indispensables pour lancer le serveur.

Lancement du serveur

La configuration étant terminée vous pouvez démarrer le serveur web en lançant la commande ci-dessous :

php artisan serve

Si tout c'est bien passé, alors vous devriez avoir accès à la page d'accueil ici http://127.0.0.1:8000/. En cas de problème, vérifiez les configurations de la base données. Si le problème persiste, contactez-nous directement.

📁 Serveur CDN NodeJS - RESAC (optionel)

L'utilisation du serveur CDN n'est pas obligatoire, cependant son utilisation en local comme en production permet d'augmenter le temps de réponse du serveur, ce qui est très intéressant, mais attention, son utilisation exige une grande attention car les fichiers statiques qui sont sur le serveur CDN et ceux sur le serveur web doivent toujours être les mêmes !

De plus, il n'y pas encore de documentation sur son utilisation. Soyez donc conscient de ce que vous faites avant de l'utiliser.

Installation

Placer vous dans le dossier parent du projet puis exécuter la commande

git clone https://github.com/jdjebi/RESAC-CDN.git

Une fois le téléchargement terminé, installer les dépendances

cd "RESAC-CDN"
npm install

Lancement du serveur

npm start

Le serveur sera disponible à cette adresse http://localhost:3800

Configuration

Il faut informer Laravel que l'on souhaite utiliser le serveur CDN. Pour ce faire, remplacer RESAC_USE_CDN=false par RESAC_USE_CDN=true dans le fichier .env. On aura donc:

RESAC_USE_CDN=true 
RESAC_CDN_HOST=http://localhost:3800

RESAC_CDN_HOST est l'adresse qui sera utilisée. Dans notre cas on utilise notre serveur local, qui a pour adresse http://localhost:3800 par défaut.

Avec cette configuration, RESAC va fixer la recherche des fichiers statiques comme suite:

GET http://localhost:3800/css/resac/resac.css # Avec CDN

Au lieu de

GET http://localhost:8000/asset/css/resac/resac.css # Sans CDN

On ne s'étendra pas sur le sujet, mais dans la pratique seul les fichiers chargés à l'aide de la fonction cdn_asset("<path>") seront recherchés sur le serveur CDN.

Conseil d'usage

Lancer toujours le serveur CDN avant le serveur web.

---

Ainsi prend fin ce wiki !