/pa-website-validator

Tool di validazione per i siti di comuni e scuole

Primary LanguageHTMLBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

developers.italia App di valutazione dell'adesione ai modelli

Un applicativo desktop a supporto degli sviluppatori che aiuta a valutare la qualità dei siti istituzionali dei Comuni e delle scuole e la corrispondenza a molti dei criteri di conformità della misura 1.4.1 del PNRR Esperienza del cittadino nei servizi pubblici digitali.

Le App di valutazione sono strumenti che integrano la libreria Lighthouse ed effettuano test per la verifica della corretta adesione al modello Comuni e al modello scuole di Designers Italia.

Scopri di più sulle App di valutazione.

Funzionalità

  • Possibilità di lanciare l'auditing su un sito web online o in locale.
  • Possibilità di utilizzare il pacchetto come dipendenza global eseguendolo come cli-application.
  • Possibilità di integrare il pacchetto come dipendenza NPM in progetti terzi.

Test del modello Scuole

Test Descrizione
Criteri di conformità Vengono mostrati i risultati degli audit relativi ai criteri di conformità del modello scuole.
Raccomandazioni progettuali Vengono mostrati i risultati degli audit relativi alle raccomandazioni progettuali del modello scuole.
Test aggiuntivi Vengono mostrati i risultati di test standard forniti da lighthouse. Non sono rilevanti in termini di raggiungimento dei criteri di conformità, ma rappresentano comunque indicazioni utili a valutare eventuali miglioramenti del sito.
Raccomandazione progettuale "R.SC.3.1 - Velocità e tempi di risposta" Viene mostrato il risultato del test relativo alla raccomandazione progettuale "R.SC.3.1 - Velocità e tempi di risposta" per il sito scolastico.

Test del modello Comuni

Test Descrizione
Pacchetto Cittadino Informato: criterio "C.SI.4.1 - Velocità e tempi di risposta" Viene mostrato il risultato del test relativo al criterio "C.SI.4.1 - Velocità e tempi di risposta" per il sito comunale.
Pacchetto Cittadino Informato: criteri di conformità Vengono mostrati i risultati degli audit relativi ai criteri di conformità per il sito comunale.
Pacchetto Cittadino Attivo: criteri di conformità Vengono mostrati i risultati degli audit relativi ai criteri di conformità per i servizi digitali comunali.
Pacchetto Cittadino Informato: raccomandazioni progettuali Vengono mostrati i risultati degli audit relativi alle raccomandazioni progettuali per il sito comunale.
Test aggiuntivi Vengono mostrati i risultati di test standard forniti da lighthouse. Non sono rilevanti in termini di raggiungimento dei criteri di conformità, ma rappresentano comunque indicazioni utili a valutare eventuali miglioramenti del sito.

Tecnologie

PA Website Validator utilizza le seguenti tecnologie

  • Node.js - Javascript runtime
  • npm - Gestore di pacchetti
  • Lighthouse - Libreria principale estesa per l'esecuzione degli audit
  • Typescript - Linguaggio di programmazione fortemente tipizzato che si basa su JavaScript

Requirements

PA Website Validator necessita Node.js v18+ (LTS), npm e Google Chrome.

Plugins

PA Website validator utilizza le seguenti dipendenze esterne principali

Plugin Repository
Lighthouse GitHub
Yargs GitHub
Puppeteer GitHub
Cheerio GitHub
JSDOM GitHub
Geo Ip GitHub
Get SSL Certificate GitHub

Installazione locale

Per l'installazione locale, una volta clonato il repository, eseguire:

cd pa-website-validator
npm install

La directory dist sarà popolata con l’output del processo di build.

Utilizzo:

node dist --type <type> --destination <folder> --report <report_name> --website <url> --scope <local|online> --view

Esempio:

node dist --type school --destination ~/pa-italia-crawler-reports --report myreport --website https://www.ismonnet.edu.it/ --scope online --view --accuracy all

NB: per i dispositivi basati su macOS con processore ARM occorre abilitare la variabile d’ambiente PUPPETEER_EXPERIMENTAL_CHROMIUM_MAC_ARM per tutti i comandi descritti sopra, cioè:

PUPPETEER_EXPERIMENTAL_CHROMIUM_MAC_ARM=1 npm install
PUPPETEER_EXPERIMENTAL_CHROMIUM_MAC_ARM=1 node dist ...

Installazione globale

Una volta effettuata l’installazione globale sarà possibile usare il comando pa-website-validator dal terminale, senza dover entrare nella directory clonata. Questa è la procedura per installare il comando globalmente:

cd pa-website-validator
npm install
npm install -g --install-links

(usare PUPPETEER_EXPERIMENTAL_CHROMIUM_MAC_ARM se necessario come descritto sopra).

NB: Potrebbe essere necessario riavviare la shell/terminale per la propagazione del comando e la pulizia della cache npm:

npm cache clean

Utilizzo:

pa-website-validator --type <type> --destination <folder> --report <report_name> --website <url> --scope <local|online> --view

Esempio:

pa-website-validator --type school --destination ~/pa-italia-crawler-reports --report myreport --website https://www.ismonnet.edu.it/ --scope online --view --accuracy all

Opzioni comando

Parametro Comando Descrizione Obbligatorio Possibili valori Default
- -help Mostra la mappa comando ❌
- -version Versione del pacchetto ❌
- -type Tipologia di crawler da lanciare ✅ "municipality" "school"
- -destination Folder dove salvare la reportistica ✅
- -report Nome da assegnare al report ✅
- -website Url sito web da analizzare ✅
- -scope Scope di esecuzione ❌ "local" "online" "online"
- -view Visualizzazione istantanea report ❌
- -accuracy Definisce la morbosità della scansione ✅ "min", "suggested", "high", "all" "suggested"

Note:

  • --type indica quale tipologia di sito web viene passato da ispezionare (comunale o scolastico).

  • --scope indica la tipologia di audit da eseguire:

    • local se il tool è lanciato su un sito web in ambiente locale: esegue tutti gli audit che lavorano sulla struttura del sito ispezionato e mostra dei messaggi informativi per alcuni audit che non producono risultati se eseguiti in un ambiente locale.
    • online esegue tutti gli audit disponibili.

  • --view se passato al comando alla fine dell'auditing lancia un'istanza di chrome che mostra automaticamente la reportistica generata.

  • --accuracy indica la precisione della scansione, definita come il numero di pagina analizzate:

    • all la scansione è effettuata su tutte le pagine disponibili.

Generazione pacchetti MacOS per Apple silicon

I pacchetti delle app per MacOS basati su architettura ARM non possono essere generati automaticamente dalla Action di GitHub come avviene per gli altri. Queste sono le istruzioni per generarli manualmente:

  1. Scaricare il binario di NodeJS da qui e decompattarlo in una directory, es. ~/Downloads. (Attenzione: scaricare il binario e non l'Installer o altra distribuzione).

  2. Aprire un Terminale e copiare i seguenti comandi:

    export PATH="$HOME/Downloads/node-v18.15.0-darwin-arm64/bin:$PATH"
cd pa-website-validator
git pull
rm -rf dist node_modules
PUPPETEER_EXPERIMENTAL_CHROMIUM_MAC_ARM=1 npm install
LICENSE_KEY="chiave licenza GeoIP valida" npm run updateGeoIPData
./scripts/create-zips.sh macOS arm64

  3. Caricare i pacchetti generati nella pagina della release di GitHub.