From 887299737e9de095cefeeb10cc72ba28dd9b13ba Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi <256895@studenti.unimore.it> Date: Mon, 26 Apr 2021 15:20:26 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=97=92=20Add=20README=20for=20the=20front?= =?UTF-8?q?end?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- code/frontend/README.md | 47 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 46 insertions(+), 1 deletion(-) diff --git a/code/frontend/README.md b/code/frontend/README.md index 7c5363a..655b101 100644 --- a/code/frontend/README.md +++ b/code/frontend/README.md @@ -1,9 +1,54 @@ # `nest-frontend` +Una webapp in React che si interfaccia con il server principale di N.E.S.T. attraverso un web API. + +## Requisiti + +Per eseguire il frontend in modalità development, è richiesto: + +- [Node.JS Current](https://nodejs.org/it/download/current/) + ## Installazione -## Configurazione +Per installare le dipendenze del frontend, è necessario eseguire in questa cartella: + +```bash +npm install +``` + +Questo scaricherà da [npm](https://www.npmjs.com/) tutte le dipendenze necessarie ad avviare il development server, +e le inserirà nella cartella `node_modules`. + +> Nota: La cartella `node_modules` **non deve essere committata**! + +## Avvio + +Per avviare il development server del frontend, è necessario eseguire in questa cartella: + +```bash +npm start +``` + +Questo avvierà un webserver su `localhost` legato alla porta TCP `3000`. ## Sviluppo +Mentre il development server è avviato, qualsiasi modifica verrà immediatamente applicata sulla +[pagina web di anteprima](https://localhost:3000). + +## Documentazione + + + +🚧 La generazione automatica della documentazione non è ancora disponibile. + ## Deployment + +Per compilare il frontend in una webapp ottimizzata per l'uso in production, è necessario eseguire in questa cartella: + +```bash +npm build +``` + +La pagina web e le sue risorse saranno create all'interno della cartella `build`, pronte per essere servite tramite +un qualsiasi webserver di pagine statiche. \ No newline at end of file