Gng-ecomm-sdk NPM

gng-ecomm-sdk

Introduction

Bienvenue dans le sdk front!

Le sdk front sert de lien entre les différents fronts du E-comm et nos autres projets internes. Il communique donc majoritairement avec gng-ecomm-admin-sdk et gng-tb-firebase-functions Il est possible de travailler en linked avec le sdk-admin en faisant yarn link-sdk, et ensuite de travailler en linked à partir du front pour faire des modifications dans le sdk admin et les voir localement dans le front.

Comme tous les autres projets, toujours s'assurer de yarn avant tout pour être sur de ne pas avoir des erreurs à cause d'un manque de dépendances.

Installation

Pour installer le package pour développer en local, copier ces deux lignes dans le package.json du site "front" (section scripts):

"link-sdk": "yarn remove gng-ecomm-sdk && cd ../gng-ecomm-sdk && yarn link && cd node_modules/react && yarn link && cd ../react-dom && yarn link && cd ../gng-ecomm-admin-sdk && yarn link && cd ../../../SITE/ && yarn link react && yarn link react-dom && yarn link gng-ecomm-sdk && yarn link gng-ecomm-admin-sdk",
"unlink-sdk": "yarn unlink react && yarn unlink react-dom && yarn unlink gng-ecomm-sdk && yarn unlink gng-ecomm-admin-sdk && cd ../gng-ecomm-sdk/node_modules/react && yarn unlink && cd ../react-dom && yarn unlink && cd ../gng-ecomm-admin-sdk && yarn unlink && cd ../../ && yarn unlink && cd ../SITE/ && yarn update-sdk"
"update-sdk": "yarn add gng-ecomm-sdk@latest"

Remplacez les mots SITE par le nom du dossier du dossier, par exemple pour Larivière-Meunier, je remplacerais SITE par www.larivieremeunier.com (Puisque c'est le nom du repo GitHub et le nom du dossier dans mes fichiers.)

Branches :

Pour le gng-ecomm-sdk, on fonctionne avec des versions publiées sur npm, alors la seule branche utilisée à long terme est master. On doit donc toujours partir de la branche master à jour pour le développement.

Dans un contexte ou on doit faire beaucoup de modifications en peu de temps et pour éviter de faire des versions complètes et de prendre la chance que ça tombe en ligne, on peut aussi faire des canarys.

Pour faire une nouvelle version:

Partir une branche de master en faisant

git checkout master
git pull
yarn
git checkout -b master-[code de la tâche zoho]

Faire les modifications, les tester localement si possible et ensuite pousser tes modifications.
Créer une pull request vers master et attendre l'approbation d'un autre dev
Une fois la pull request approuvée, fusionner le tout
Publier la nouvelle version sur master en faisant

  git checkout master
  git pull
  yarn
  yarn build
  yarn pub

et répondre aux questions avec le terminal git bash

Une fois la nouvelle version publiée, elle devient accessible sur les différents front du E-comm en faisant yarn update-sdk

Pour faire un canary:

Partir une branche de master de la même façon que quand on veut faire une nouvelle version
Lorsque le temps est venu de pousser les modifs, à la place de directement faire une pull request vers main, faire yarn pub directement dans la branche
Dire oui à la question pour créer un canary
Une fois le nouveau canary publié, il devient accessible sur les différents front du E-comm en faisant yarn update-canary

ATTENTION: Il ne peut exister qu'un canary pour une version à un même moment, il est donc impossible d'avoir une version principale avec deux branches de développement différentes qui ont un canary.

Utilisation :

Lorsque vous voulez développer en local avec le sdk-front, vous devez premièrement faire un yarn build et ensuite un yarn link ici.

Par la suite, dans le front, vous devez utiliser les commandes yarn link-sdk et yarn unlink-sdk, ces commandes linkeront react, react-dom, et le gng-ecomm-sdk à votre site.