Piral est une bibliothèque JavaScript permettant de créer des applications modulaires "microfrontends" basées sur React.
Les microfrontends étendent le concept de microservices aux applications frontales et aident les développeurs à faire face à la taille et à la complexité sans cesse croissantes des applications JavaScript en décomposant une seule SPA (Single Page Application) en plusieurs applications autonomes.
Une configuration simple de microfrontends implique une application shell qui charge un ensemble de modules autonomes en fonction du routage.
Dans Piral, l'application shell est appelée "instance Piral". Les modules autonomes sont appelés "Pilets", tous deux pouvant être générés par le CLI de Piral.
L'instance Piral gère trois aspects de l'application :
- La mise en page de l'application (par exemple, le pied de page, l'en-tête, etc...)
- Les composants communs qui peuvent être partagés entre les différents Pilets
- La manière dont les Pilets sont chargés et définit où ils peuvent intégrer les composants partagés
Les Pilets sont des applications web individuelles qui gèrent différents aspects du site web. Bien que le CLI de Piral utilise par défaut React, les développeurs peuvent construire des Pilets en utilisant d'autres bibliothèques telles que Angular ou Vue.js en utilisant les plugins fournis.
Pour commencer avec Piral, installez d'abord la CLI de Piral au niveau global en utilisant :
npm I piral-cli -g
Une fois que Piral CLI est installé, une nouvelle application Piral peut être générée en exécutant :
piral new --target app-name
Cela va générer une application shell simple qui inclut la mise en page de base. Avant de générer les Pilets, nous devons d'abord exécuter piral build, qui génère un dossier dist contenant deux paquets - release et emulator.
Le paquet de l'émulateur est utilisé pour générer les Pilets et sera généralement publié dans un registre NPM privé afin de garantir que tous les modules utilisent la dernière mise en page.
Pour générer le Pilet, exécutez :
pilet new emulator-name --target pilet-name
Où le nom de l'émulateur peut être soit le paquet npm, soit le chemin local de l'instance de l'émulateur. Pour démarrer le Pilet nouvellement créé, exécutez pilet debug, qui sera servi depuis http://localhost:1234/.
Piral s'appuie sur un service de flux qui héberge les instances de Pilets. Les développeurs peuvent définir leur propre service de flux sur la base de l'exemple fourni ou utiliser le service de flux gratuit fourni par Piral.
Une fois qu'un flux est mis en place, l'instance de Piral doit être configurée pour utiliser les Pilets à partir du flux créé. Ceci peut être fait en modifiant le "feedUrl" trouvé dans le "index.tsx" de l'application Piral.
Piral est une bibliothèque open-source qui est disponible sous la licence MIT. Les contributions sont encouragées pour participer au projet GitHub de Piral GitHub et doivent suivre le Contributor Covenant Code of Conduct.