Le specifiche del progetto sono consultabili nel file final-project.MD.
La documentazione è consultabile tramite un piccolo server HTTP che viene avviato eseguendo loadDocumentation.sh dalla directory documentation.
Lo script si occupa di generare i file - up to date - necessari per istanziare i componenti di esempio presenti nelle pagine di documentazione e di avviare il server sulla porta 1337. Una volta eseguito, la documentazione sarà quindi disponibile all'indirizzo localhost:1337.
cd documentation && ./loadDocumentation.sh-
Per avviare correttamente il server relativo alla documentazione è necessario che
python3sia installato. -
Per il corretto funzionamento degli esempi nella documentazione del componente Autocomplete è necessario eseguire
java -jar server.jar, che avvia localmente un server per il suggerimento di stringhe, e abilitare il CORS (qui un'estensione per Firefox). -
Per la corretta installazione di tutte le altre dipendenze è necessario eseguire
npm installnella root del progetto (dove si trovapackages.json).