openware-gateway v1.0.3-5
Openware Gateway
Microservizio Openware per la creazione di un proxy per le Reception 2.0
##TODO Skelethon derivato da openware-simple-proxy. LA documentazione potrebbe essere da allineare al progetto.
Raw
Inizia con copiare le variabili d'ambiente dove servono
Windows:
npm run bootstrap:env:win_ Unix:npm run bootstrap:env:unix
Sostituisci poi con i tuoi valori
Avvia in development con npm run start:dev
In questa modalità ogni volta che modifichi un file e salvi il servizio si aggiorna in automatico
Per avviare in produzione crea un file .env nella root del progetto e inserisci le variabili d'ambiente che servono.
Le stesse varaibili possono essere passate da riga di comando e hano priorità maggiore rispetto alle stesse presenti nel file.
Per maggiori informazioni su dotnenv vedi la documentazione
Avvia il servizio con npm run start
Docker
In development (hot reload) run with docker-compose --env-file ./.dev.env -f docker-compose-dev.yml up --build
Test
Avvia i test con npm test
Puoi torvare i risultati dei test in doc/test_report.html
Puoi trovare i risultati del coverage in doc/coverage/lcov-report/index.html
Documentazione
Puoi creare la documentazione con npm run doc
Puoi trovare la documentazione in doc/jsdoc
Commitare
Quando fai una commit, viene eseguito un hook che esegue eslint.
Se eslint da errore, non puoi committare.
Nel caso tu voglai saltare l'esecuzione dei git hooks puoi:
- se usi la command line, passare il parametro -n a git
- se usi webstorm, unflaggare il check Run git hooks che si trova nella parte destra della finestra del commit
Versionare
Quando fai npm version ... vangono eseguiti una serie di hooks:
- preversion: npm run lint && npm run test
- version: npm run emptyDoc && npm run doc
- postversion: git push --tags && npm publish
In modo tale che tutti i controlli e i build necessari vengano eseguiti e inoltre che il pacchetto venga pubblicato nel registro