Starter V3
Ce guide vous accompagne pas à pas pour migrer votre projet existant, basé sur le Starter v3 avec le dossier business, vers la nouvelle structure. Cette version introduit l’externalisation du setup du serveur et de l’application React dans la dépendance @fasstech/oip-starter-utils.
Ce guide suppose que vous avez respecté la structure et les bonnes pratiques du Starter v3, ainsi que celles du dossier business
Introduction
La nouvelle structure du Starter v3 a été simplifiée pour améliorer la maintenance et la lisibilité des projets. Désormais, le setup du serveur et de l’application React (anciennement contenus dans les dossiers business/server et business/app) est externalisé dans la dépendance @fasstech/oip-starter-utils.
Concrètement :
- Le dossier business/server devient server à la racine du projet.
- Le dossier business/app devient app.
La migration consiste principalement à :
- Cloner la nouvelle version du Starter v3.
- Copier/coller vos fichiers de configuration, vos vues, votre code métier et votre configuration OIP dans la nouvelle structure.
En cas de doute, n’hésitez pas à contacter l’équipe OIP pour obtenir de l’aide.
Étape 1 — Récupérer la nouvelle version du Starter
Clonez la dernière version du Starter depuis le dépôt suivant : 👉 https://github.com/fasst/fasst-oip-starter (branche main)
Étape 2 — Mettre à jour la variable d’environnement OIP_WORK_DIR
Dans votre fichier .env, modifiez la valeur de la variable OIP_WORK_DIR :
# before
OIP_WORK_DIR=./business/server
# after
OIP_WORK_DIR=./serverÉtape 3 — Récupérer vos configurations spécifiques
Fichier vite.config.js
Récupérez votre configuration spécifique du fichier vite.config.js et adaptez-la si nécessaire à la nouvelle structure.
Autres fichiers de configuration
Copiez également vos fichiers de configuration situés à la racine du projet (ex. ESLint, Prettier, etc.), en veillant à les ajuster selon la nouvelle arborescence.
Dépendances
Ajoutez vos dépendances spécifiques dans le fichier package.json de la nouvelle structure.
Étape 4 — Migration des vues et de leur configuration
Dossier viewsConfig
Copiez le dossier viewsConfig tel quel (aucune modification nécessaire).
Dossier views
Copiez votre dossier views dans la nouvelle structure.
Mettre à jour les imports de useProcess
Dans vos composants de vues, remplacez les imports de useProcess :
// before
import { useProcess } from '@@appHooks/useProcess.js';
// after
import { useProcess } from '@fasstech/oip-starter-utils/app';- Mettre à jour les imports des helpers OK et KO
Dans les resolvers de vos vues :
// before
import { OK, KO } from '../../../../../server/graphql/resolvers/helpers.mjs'
// after
import { OK, KO } from '@fasstech/oip-starter-utils/server';- De manière générale, les imports provenant de business/app et business/server doivent désormais pointer respectivement vers app et server.
Étape 5 — Migration du dossier business/server vers server
Configuration OIP
Copiez votre fichier oip.config.mjs dans le dossier server.
Mettez à jour l’import de pubsub :
// before
import { pubsub } from 'server/graphql/init-graphql.mjs';
// after
import { getPubSub } from '@fasstech/oip-starter-utils/server';
// OIP config
export default {
...
pubsub: getPubSub()
};- Logique métier
Copiez tous vos fichiers métier depuis business/server vers server à la racine.
Déplacez également votre code d’initialisation backend dans server/index.mjs.
Mettre à jour les imports des helpers OK et KO
Dans vos resolvers GraphQL métier :
// before
import { OK, KO } from '../helpers.mjs'
// after
import { OK, KO } from '@fasstech/oip-starter-utils/server';Étape 6 — Migration du dossier business/app vers app
Copiez vos fichiers métier du dossier business/app vers app à la racine.
Le fichier app/App.jsx (de la nouvelle structure) vous permet désormais de personnaliser et d’initialiser le composant principal de l’application React.
✅ Votre migration est terminée ! Vous disposez désormais d’une structure plus claire, mieux organisée et alignée avec les évolutions du Starter v3.