Skip to content
README.md 3.05 KiB
Newer Older
Fabrizio Paolucci's avatar
Fabrizio Paolucci committed
# OpenCruise

Il progetto OpenCruise è composto da due applicativi web che interagiscono tra di loro
con lo scopo di fornire una applicazione che offre all'utente la possibilità di creare/configurare 
dei report di consumo e poi visualizzarli in qualsiasi browser. 

## Installazione ed esecuzione del progetto in ambiente locale
#### Prerequisiti
- [ ] Installazione del servizio GIT da [qui](https://git-scm.com/download/win).
- [ ] Per avviare l'applicazione web è necessario installare nel ambiente locale Docker da [qui](https://www.docker.com/products/docker-desktop/).
- [ ] [Opzionale] Creazione della cartella di fonte dati per i report esistenti (Es C:\lec-data)

#### Installazione 

- [ ] Aprire la linea di comandi del sistema operativo e digitare posizionandosi nella cartella desiderata ed eseguire
    > git clone https://crossserv.bologna.enea.it/gitlab/open/opencruise


#### Esecuzione
  Per eseguire il progetto fare click sul file start.bat oppure aprire un 
  terminale di comandi del sistema operativo posizionato nella cartella che 
  contiene il codice ed eseguire il commando:

  > docker-compose up

Se l'installazione finisce con successo sarà possibile ragiungere l'applicativo 
da questo [link](http://localhost:4200).

Per chiudere l'esecuzione clic-are sul file stop.bat oppure premere CTRL+C nella finestra
della linea di commando aperta precedentemente.

#### Accesso con utente demo
  > __*Username*__: utente.ec@test.it
  > 
  > __*Password*__: energyCommunity

#### Comandi utili 
> __*docker-compose up*__  - Comando per avviare Docker
>
> __*docker-compose stop*__  - Comando per stoppare i container
> 
> __*docker-compose start*__  - Comando per riavviare i container
> 
> __*docker-compose down*__  - Comando per terminare Docker e rimuovere tutti i container creati

#### Esecuzione test
Se si entra nelle pagine interne del portale, è possibile visualizzare 2 report impostando la lingua del portale in Italiano.
I report presenti di default sono:
> Reporto consumo 
>
> Consumo e produzione abitazione

La fonte dati dei report si trova nel percorso __lecservice/src/main/resources/mocks__ e i file utilizzati sono __getData_10.json__
e __getData_35.json__. 
Se si ha la necessità di leggere dati da un altra cartella bisogna eseguire questi passi:
1. Settare un valore della variabile __MOCK_DATA_FOLDER_LOCAL__ nel file __.env__, es: __C:/lec__. Questa variabile rappresenta la cartella ne disco locale
2. Settare un valore della variabile __MOCK_DATA_FOLDER_IMG__ nel file __.env__, es: __/lec__. Questa variabile rappresenta la cartella al interno dell immagine docker
3. Stoppare docker con il commando __docker-compose down__
4. Copiare i due file indicati sopra nella cartella __C:/lec__ del disco locale. E' importante che il nome e la struttura dei file sia mantenuto uguale a quello indicato sopra.
5. Avviare docker con __docker-compose up__ oppure click-are il file start.bat
6. Modificare la sezione dei dati del file a seconda delle esigenze.
7. I report verranno popolati con i dati presenti nella cartella __/lec__ del vostro sistema operativo.