Tecnologie Membri Documentazione
Semplice rubrica telefonica realizzata in Java, che consente la gestione di contatti (nome, cognome, numero di telefoni e indirizzi e-mail), attraverso un'interfaccia grafica (GUI) realizzata in JavaFX.
L'applicazione é stata scritta in Java e necessita della JVM per l'esecuzione e di una jdk-23 installata. É stata testata con l'ultima jdk fornita direttamente da Oracle ma non dovrebbero esserci problemi anche con le versioni alternative.
L'interfaccia grafica é stata realizzata in javaFX, mediante Scene Builder. Nonostante sia stata utilizzata la jdk-23, che non include piú al suo interno le librerie relative a javaFX, non é necessario installare il relativo SDK in quanto é presente uno script Maven che si occupa automaticamente della gestione delle dipendenze. In tal caso é necessaria una connessione di rete affinché Maven possa scaricare le dipendenze dal relativo repository.
- Documentazione Latex ufficiale del progetto
- Documentazione Doxygen, disponibile anche al seguente link mediante github pages
- Mockup GUI figma
Per prima cosa é necessario clonare il progetto in locale. Si puó usare il seguente comando da terminale o utilizzare un tool dotato di GUI come Github Desktop.
git clone https://github.com/emanueletocci/uni-swe-project.git
All'interno della cartella appena scaricata sono presenti 2 sottocartelle:
- docs: contiene la documentazione (latex e doxygen) e i diagrammi UML del progetto
- sources/Rubrica: contiene il codice sorgente, il pom di maven e alcuni file di configurazione degli IDE. Il codice sorgente in particolar modo, si trova in
src/main, secondo l'organizzazione del codice imposta da Maven.
Per la compilazione é necessario raggiungere la directory sources/Rubrica. Dalla radice uni-swe-project si puó usare il seguente comando da terminale:
cd sources/Rubrica
A questo punto é possibile:
- Compilare tutti i sorgenti:
mvn compile - Eseguire gli unit test:
mvn test - Cancellare i file prodotti dalle precedenti compilazioni:
mvn clean - Eseguire l'applicazione:
mvn javafx:run
Nella directory src/main/resources/files é presente il file Noi.vcf precompilato, che puó essere importato nella rubrica per testarne le funzionalitá. La validitá del file puó essere testata mediante un tool online oppure semplicemente importandolo in un software simile, compatibile con lo standard vCard, come per esempio l'app "Rubrica" dello smartphone o del computer.
Se non si vuole seguire l'approccio da riga di comando é comunque possibile importare il progetto (sources/Rubrica) in un IDE come IntelliJ o netbeans, caricando il file pom.xml fornito.
Qualora ci fosse qualche problema con lo script Maven (pom.xml) fornito, é comunque possibile compilare ed eseguire l'applicazione scaricando manualmente la SDK di javaFX e specificando il suo percorso, come spiegato nella wiki ufficiale.
Nell'ultima release sono stati forniti 2 file .jar direttamente eseguibili, realizzati mediante il plugin shade di maven che consente di incorporare direttamente le dipendenze (javaFX) scaricate nel .jar. É presente una versione aarch64 ed una versione x86, bisogna tuttavia tener presente che la compilazione é avvenuta in ambiente linux (x86) e macOS (aarch64) pertanto le dipendenze incorporate da shade potrebbero non essere completamente soddisfatte sugli altri sistemi operativi, dal momento che le dipendenze scaricate da Maven sono specifiche per quel determina SO.