Aller au contenu principal

Helpers

Le paquet @churchapps/helpers fournit les utilitaires de base utilisés par tous les projets ChurchApps, à la fois frontend et backend. Il est indépendant du framework et inclut les helpers communs tels que DateHelper, ApiHelper, CurrencyHelper et d'autres utilitaires partagés.

Avant de commencer

  • Installer Node.js et Git -- voir Prérequis
  • Vous familiariser avec le workflow npm link pour le développement local

Configuration pour le développement local

  1. Cloner le référentiel :

    git clone https://github.com/ChurchApps/Helpers.git
  2. Installer les dépendances :

    cd Helpers && npm install
  3. Construire le paquet (compile TypeScript vers dist/) :

    npm run build
  4. Le rendre disponible pour la liaison locale :

    npm link

Vous pouvez alors le lier dans n'importe quel projet de consommation :

cd ../YourProject && npm link @churchapps/helpers

Publication

Pour publier une nouvelle version sur npm :

  1. Mettre à jour la version dans package.json

  2. Publier :

    npm publish --access=public
attention

Puisque ce paquet est utilisé par chaque projet ChurchApps, les changements ici ont un impact large. Tester complètement avec npm link dans au moins une API de consommation et une application web de consommation avant de publier.

Articles connexes