Skip to content
This repository has been archived by the owner on Dec 21, 2022. It is now read-only.

LenhardErwan/BeerBrowser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BeerBrowser

Réalisé dans le cadre de nos études, BeerBrowser est une application simple utilisant ReactJS, Webpack et PunkAPI pour effectuer des recherches sur des bières.

Installation

Pour utiliser cette application sur votre machine, il faut d'abord installer npm et nodejs. Une fois cela fait, il vous suffit d'exécuter la commande suivante dans le dossier racine du projet : npm install Enfin pour exécuter l'application : npm run start Vous pouvez désormais lancer votre navigateur favori et accéder au lien qui vous est donné (par défaut localhost:2345)

Auteurs

Castel Jérémy et Lenhard Erwan


Modification

La première itération de notre programme était basé sur du JavaScript pur. Pour notre deuxième itération nous avons basé celui-ci sur ReactJS.

  1. Framework
    Comme demandé, nous avons utilisé le Framework ReactJS pour faire cette 2ᵉ itération du projet. Ce qui nous a permis de ne plus utiliser les templates HTML.

  2. Programmation Orientée Objet (POO)
    La première modification est une bien meilleure gestion de la POO. En effet, lors de notre première version nous avions un unique fichier qui se chargeait de tout l'affichage. Avec la mise en place de ReactJs, nous avons désormais 4 classes héritant de la classe Component de ReactJS. Chacune de ces classes permet l'affichage du composant qu'elle définit.
    Nous avons donc App qui est le point d'entré de notre application React et c'est elle qui se charge des 3 composants, qui sont Nav, List et Beer. C'est l'une des choses, que lors de notre première revue, il nous a été conseiller d'améliorer. De plus séparer le code de la sorte nous permet d'utiliser plusieurs fois un même composant dans des contextes différents. Par exemple, nous utilisons List lors d'une recherche, mais aussi dans le composant Beer pour afficher les bières similaires.

    • Nav : barre de navigation, avec la recherche et le bouton pour avoir une bière aléatoirement.
    • List : Liste les bières en fonction de la recherche.
    • Beer : Affiche les caractéristiques d'une bière, ainsi que des bières similaires.
  3. Import
    Lors de notre première revue, il nous a été montré que nous utilisions encore des URL, notamment pour les polices d'écritures, chose que nous avons amélioré en rendant les polices d'écritures dépendantes du projet.

  4. Route
    La mise en place de ReactJS et la structure initiale de l'application qui se compose de deux pages différentes, nous ont forcé à chercher une méthode propre pour naviguer entre les sections. Nous avons opté pour le module npm @Reach/Router qui est très simple d'utilisation et souvent mis à jour. Il permet par le biais de Component appelés Router de définir le chemin qui méne à un composant. Il suffit ensuite d'utiliser la méthode navigate pour parcourir les chemins définis. Une documentation très détaillé est également disponible.

  5. Modèle
    La classe Model a légèrement été modifié pour qu'elle soit plus simple à utiliser

  6. Amélioration

    • Le fait de se re-servir de la classe List dans Beer permet de rendre les bières similaire cliquable
    • Nous avons ajouter une dépendance à Toastr, qui permet de faire des toast très facilement, ce qui rend les interactions avec l'utilisateur bien plus agréable.