mirror of
https://github.com/pds-nest/nest.git
synced 2024-11-25 14:34:19 +00:00
🗒 Add README for the frontend
This commit is contained in:
parent
5dde6add85
commit
887299737e
1 changed files with 46 additions and 1 deletions
|
@ -1,9 +1,54 @@
|
||||||
# `nest-frontend`
|
# `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
|
## 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
|
## Sviluppo
|
||||||
|
|
||||||
|
Mentre il development server è avviato, qualsiasi modifica verrà immediatamente applicata sulla
|
||||||
|
[pagina web di anteprima](https://localhost:3000).
|
||||||
|
|
||||||
|
## Documentazione
|
||||||
|
|
||||||
|
<!-- TODO: Questa parte non è ancora stata realizzata. -->
|
||||||
|
|
||||||
|
🚧 La generazione automatica della documentazione non è ancora disponibile.
|
||||||
|
|
||||||
## Deployment
|
## 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.
|
Loading…
Reference in a new issue