1
Fork 0
mirror of https://github.com/pds-nest/nest.git synced 2024-11-26 23:14:19 +00:00
pds-2021-g2-nest/code/frontend/README.md

54 lines
1.4 KiB
Markdown
Raw Normal View History

2021-04-15 23:54:35 +00:00
# `nest-frontend`
2021-04-26 13:20:26 +00:00
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/)
2021-04-15 23:54:35 +00:00
## Installazione
2021-04-26 13:20:26 +00:00
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`.
2021-04-15 23:54:35 +00:00
## Sviluppo
2021-04-26 13:20:26 +00:00
Mentre il development server è avviato, qualsiasi modifica verrà immediatamente applicata sulla
2021-04-26 13:45:20 +00:00
pagina web di anteprima a http://localhost:3000 .
2021-04-26 13:20:26 +00:00
## Documentazione
<!-- TODO: Questa parte non è ancora stata realizzata. -->
🚧 La generazione automatica della documentazione non è ancora disponibile.
2021-04-15 23:54:35 +00:00
## Deployment
2021-04-26 13:20:26 +00:00
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.