Fab_Blab/FreeDatas2HTML
1
1
Fork 0
Code Issues Pull Requests Projects Releases Activity

Mise à jour de 'README.md'

Browse Source 
Revue du texte, la première version de l'application étant finalisée.
This commit is contained in:
Fab_Blab 2021-11-10 16:29:38 +01:00
parent df09e1708e
commit 35a5c6dbfa
1 changed files with 7 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -1,36 +1,19 @@
# freeDatas2HTML # FreeDatas2HTML
Affichage et manipulation de listes données côté client en TypeScript/JavaScript.
## Le projet
Des données sont déjà listées dans une page HTML ou sont accessibles via une API ou encore un fichier présent "localement". Des données sont déjà listées dans une page HTML ou sont accessibles via une API ou encore un fichier présent "localement".
Ces données peuvent être stockées en CSV, JSON ou autres formats. Ces données peuvent être stockées en CSV, JSON ou autres formats.
Nous souhaitons pouvoir les afficher, filtrer, classer ou paginer en agissant uniquement côté client, sans nouvel appel à la source des données.
L'esprit est proche du projet [DataTables](https://www.datatables.net/), mais sans dépendances à jQuery. Nous souhaitons pouvoir les afficher, les filtrer, classer ou paginer en agissant uniquement côté client, sans nouvel appel à la source des données.
Si le code source de freeDatas2HTML est écrit en TypeScript, une version compilée en JavaScript natif ("Vanilla") est disponible. Toutes les fonctionnalités sont en options et aucun CSS n'est imposé pour le rendu.
De même l'idée est de rester libre du rendu des données en n'imposant pas de CSS et en proposant les diverses fonctionnalités en options. Plus d'information et exemples sur [le site de démonstration](https://freedatas2html.le-fab-lab.com), qui peut être lancé localement via WebPack.
## La première version ## Le code
La première version se contente de récupérer et parser des données présentes dans un fichier CSV via un appel Ajax. Le code source de FreeDatas2HTML est écrit en TypeScript (répertoire "src"), une version compilée en JavaScript "Vanilla" étant disponible dans le sous-répertoire "build".
Les données trouvées sont affichées dans un tableau. En option, des colonnes peuvent être indiquées pour filtrer les données et/ou les classer.
Il est possible de fournir des fonctions spécifiques pour classer les données de certaines colonnes.
Il est également possible de paginer les résultats ou encore de modifier l'affichage des données (par défaut un tableau).
Le tout **en options**, le développeur final devant pouvoir adapter le module à son besoin. L'ensemble est testé via [Karma.js](https://karma-runner.github.io) et [Jasmine.js](https://jasmine.github.io/) sur les navigateurs Firefox et Chromium.
Il reste à ajouter :
- la possibilité d'utiliser des sources/formats différents qu'un fichier CSV pour extraire les données.
## Tests et exemples
L'utilisation de TypeScript élimine déjà pas mal d'erreurs.
Le code est ensuite testé via [Karma.js](https://karma-runner.github.io) et [Jasmine.js](https://jasmine.github.io/) sur des navigateurs Firefox et Chromium.
Un premier exemple d'utilisation est présent dans le répertoire "public".
## Dépendances en production ## Dépendances en production