Wheel Us Go est une application web centrée sur la planification et l'organisation de sorties entre famille, amis ou amoureux, au restaurant, dans les bars ou «chez soi».
Qui seront présentes dans le MVP (Minimum Viable Product):
- Profil utilisateur avec photo
- Badges de récompenses (par exemple «Un début à tout !» pour la prmeière sortie organisée, ou encore «Adepte des bars» après 10 participations à une sortie bar)
- Création de salles (restaurant, bar ou «chez soi»)
- Choix du lieu, soit défini, soit par vote ou en alétoire en permettant aux invités d'ajouter des propositions
- Ajout de la date et de l'heure
- Invitations d'autres personnes dans la salle
- Possibilité d'ajouter un dresscode ou de choisir qui paye l'apéro parmis les personnes invitées grâce à une roue aléatoire
- Ajout d'amis
Fonctionnalités futures:
- Messagerie instantanée, entre deux personnes ou en groupe
- Fonction premium permettant l'accès à des recettes de cuisine ou boissons inédites, sur des thèmes différents
- Visiter le profil d'autres utilisateurs
- Recherche d'utilisateurs et visite de leur profil
Avant de pouvoir commencer à travailler sur le projet, il est nécessaire de le cloner. Il faut ensuite se placer sur la branche sur laquelle on souhaite travailler.
git clone https://github.com/CindyGraffin/wheel_us_go.git // clone le projet en local
npm install // installe tout les packages nécessaires au projet
git fetch --all // récupérer les mises à jour distantes
git switch branch_name // permet de se placer sur une branche distante non disponible en local
git checkout branch_name PUIS git pull // permet de se placer sur une branche disponible en local et avec pull de synchroniser les changements qui auraient pu être apportés au repo distant sur cette branche
Convention de nomage:
<branch_type>/<branch_name> : Il faut nommer ses branches de cette façon, par exemple feature/navbar. On utilisera deux types de branches:
- feature: Pour le développement d'une nouvelle fonctionnalité ou d'un composant
- bug: Lorsque vous constatez un bug sur votre branche, créer une branche bug à partir de celle-ci, par exemple bug/navbar
❗ Avant de créer une nouvelle branche ne provenant pas d'une fonctionnalité existante, il faut se placer sur la branche remote dev, on ne crée pas de branche à partir de la branche main. Pour ajouter des fonctionnalités à une branche déjà créée autre que dev, il faut créer une branche à partir de la branche de la fonctionnalité correspondante et non à partir de la branche dev.
Exemple: je dois produire la Navbar qui contient x items différents.
- Je commence par créer ma branche "navbar"
git checkout dev // Je me positionne sur la branche dev
git pull // Je met à jour mon dépôt local sur la branche dev
git checkout -b feature/navbar dev // Je crée ma branche "navbar" à partir de la branch "dev" et me positionne dessus
git branch // Je vérifie que je suis bien sur la branche "navbar"
- Je crée une branche "navbar_item" à partir de la branche "navbar" afin de travailler sur le composant item qui représentera un item unique de ma navbar
git checkout -b feature/navbar_item feature/navbar // Je crée ma branche "navbar_item" à partir de la branch "navbar" et me positionne dessus
git branch // Je vérifie que je suis bien sur la branche "navbar_item"
❗ Une branche = Une fonctionnalité ou un composant
🆘 Rappel des commandes git concernant les branches et utiles au projet:
git branch // Voir les branches existantes
git checkout -b new_branch_name existing_branch_name // permet de créer une branche à partir d'une autre branche existante
git branch branch_name // Crée une branche avec le nom de "branch_name"
git checkout branch_name // Se positionne sur la branche "branch_name"
git checkout -b branch_name //Crée une branche et se positionne dessus
git branch -d branch_name // Supprime la branche "branch_name", à utiliser SEULEMENT une fois le travail mergé avec une autre branche
git merge branch_to_merge // Permet de merger la branche "branch_to_merge" sur la branche sur laquelle on se trouve
Convention d'écriture du commentaire:
"commit_type(feature_name): courte description :gitmoji:"
Il existe deux type de commit:
- feat: pour un commit concernant le développement d'une nouvelle fonctionnalité ou d'un composant
- fix: lorsqu'un commit concerne la résolution d'un bug
Retrouvez les gitmojis sur ce lien: gitmoji.dev
Rappel: Réaliser un commit
git add file1 file2 file3 // Permet d'ajouter les fichiers à commit
git commit -m "feat(navbar): création du composant navbar :sparkles:" // Permet de commit les changements apportés à la navbar
git push // Permet de pusher les changements qui ont été commits sur le dépôt distant
👩 Cindy Graffin
Github: CindyGraffin
LinkedIn: Cindy Graffin
Mail: graffincindy@gmail.com
👨 Anthony Labesse
Github: StudioAzur
LinkedIn: Anthony Labesse
Mail: alnetweb59@gmail.com
👨 Boubacar Sidiky DEMBELE
Github: BoubaM2i
LinkedIn: Boubacar Sidiky DEMBELE
Mail: boubacabko@gmail.com
👨 Sofian Mejeddar
Github: aceovic
LinkedIn: Sofian Mejeddar
Mail: sofian.mejeddar@hotmail.fr
👨 Roland Leteneur
Github: EresseaNui
LinkedIn: Roland Leteneur
Mail: leteneur.roland@hotmail.com