unimore/pds-2021-g2-nest
unimore/pds-2021-g2-nest
1
Fork 0
mirror of https://github.com/pds-nest/nest.git synced 2024-11-22 04:54:18 +00:00
Code Activity

🗒 Documentazione

Browse source
This commit is contained in:
Stefano Pigozzi 2021-05-06 03:13:06 +02:00
parent 079f62e278
commit c34caac724
Signed by untrusted user who does not match committer: steffo
GPG key ID: 6965406171929D01
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
code/backend/README.md
View file

@ -64,6 +64,9 @@ In seguito, è possibile avviare il backend con:
python -m nest_backend
```
> Nota: eseguire questo programma in modalità ottimizzata (`python -OO -m nest_backend`)
> disattiverà completamente le funzionalità di documentazione automatica, pertanto è **fortemente sconsigliato**.
## Sviluppo
Le pagine web del server sono disponibili a http://127.0.0.1:5000 .
@ -71,7 +74,14 @@ Le pagine web del server sono disponibili a http://127.0.0.1:5000 .
Mentre il development server è avviato, _buona parte_ delle modifiche saranno rilevate e applicate automaticamente
senza dover riavviare il server. Per testare la connettività, visitare http://127.0.0.1:5000/doa.
## Documentazione
Mentre il server è avviato, la documentazione sarà disponibile a http://127.0.0.1:5000/docs/ .
## Deployment
Per effettuare il deployment in production,
seguire [la guida ufficiale di Flask](https://flask.palletsprojects.com/en/1.1.x/deploying/).
> Nota: un bug attualmente impedisce a questo programma di essere installato su percorsi diversi da `/`.
> Usare sottodomini e virtualhosts se è necessario avere più servizi web in esecuzione sullo stesso server!