@amsom-habitat/amsom-excel-extractor 1.0.0

package/README.md

@@ -0,0 +1,77 @@
+# AMSOM Excel Extractor
+
+Ce package propose un composant d'extraction excel pour Vue.js
+
+## Installation
+
+```bash
+npm i @amsom-habitat/amsom-excel-extractor
+```
+
+Importer les css dans le main.js tel que :
+
+```javascript
+import '@amsom-habitat/amsom-excel-extractor/dist/style.css'
+```
+
+Pour utiliser le package:
+
+```javascript
+import { AmsomExcelExtractor } from '@amsom-habitat/amsom-excel-extractor'
+```
+
+## Développement
+
+Après avoir fait vos développements, veillez à bien tenir à jour le [changelog.md](changelog.md) ainsi que la version du package.json puis faites :
+
+```bash
+git add .
+git commit -m '<commentaire>'
+git push origin <branch>
+```
+
+## Tests
+
+Les tests sont réalisés de manière automatique sur les branches main et dev mais peuvent être faits localement, notamment pour voir l'évolution du développement via la commande :
+
+```bash
+npm run storybook
+```
+
+Le valideur devra, si des changements sont observés, aller sur la pipeline pour valider les différences à l'aide de chromatic, sans cela aucun merge-request ne sera possible. Si un merge est effectué, une double vérification sera nécessaire.
+
+## Déploiement
+
+Après avoir merge les dev sur la branche main, exécutez :
+
+```bash
+make publish
+```
+
+Cette commande vérifie la version, le changelog et publie le tout
+
+## Utilisation
+
+#### Props
+
+- `user-is-logged` : Booléen indiquant si l'utilisateur est connecté ou non
+- `password-access-to-create-model` : Mot de passe requis pour créer un modèle d'extraction
+
+#### Exemple complet
+
+```vue
+<template>
+  <amsom-excel-extractor
+    :user-is-logged="true"
+    password-access-to-create-model="votre_mot_de_passe"
+    :can-access-to-create-model="true"
+  />
+</template>
+
+<script>
+import '@amsom-habitat/amsom-excel-extractor/dist/style.css'
+import { AmsomExcelExtractor } from '@amsom-habitat/amsom-excel-extractor'
+
+export default { name: 'TestPage', components: { AmsomExcelExtractor } }
+</script>
+```

package/dist/amsom-excel-extractor.js

@@ -0,0 +1,5 @@
+import { j as r, i as t } from "./index-DR0xw6Tj.js";
+export {
+  r as AmsomExcelExtractor,
+  t as default
+};