Update README
This commit is contained in:
parent
e095270fb3
commit
86d692381d
22
README.md
22
README.md
@ -19,6 +19,22 @@ const API_CONFIG = {
|
||||
export default API_CONFIG;
|
||||
```
|
||||
|
||||
## Struttura e funzionamento base
|
||||
|
||||
### Entry point
|
||||
|
||||
Il punto d'ingresso dell'applicazione è `webgis/js/index.js` che registra i controller Stimulus, inizializza alcune funzioni UI che potrebbero essere migrate in un controller Stimulus dedicato in futuro.
|
||||
|
||||
### Mappa
|
||||
|
||||
La mappa è gestita con Leaflet dalle funzioni definite nel modulo `GIS` (`webgis/js/gis.js`) che carica i layer iniziali, inclusi i geoJSON necessari, interroga le API server per recuperare i dati dal database e crea i cluster di puntatori (_markers_) tramite il plugin `Leaflet.markercluster`.
|
||||
|
||||
### Pseudo-componenti HTML
|
||||
|
||||
Il contenuto HTML mostrato nei modali che si aprono cliccando sui puntatori è gestito dinamicamente da pseudo-componenti rappresentati da classi JavaScript che si trovano in `webgis/js/components`.
|
||||
|
||||
Potrebbe essere utile (o auspicabile) trasformarli in Web Components veri e propri, magari tramite [_Lit.js_](https://lit.dev/). In questo caso, bisognerebbe capire come gestire i dati dinamici all'interno dei template.
|
||||
|
||||
## Dipendenze
|
||||
|
||||
Le dipendenze sono gestite con `yarn`, per installarle è sufficiente eseguire `yarn` dalla cartella `webgis/js`, dove si trova `package.json`.
|
||||
@ -35,6 +51,12 @@ Photo Sphere Viewer, Three.js (da cui dipende Photo Sphere Viewer) e Stimulus.
|
||||
|
||||
- [Leaflet](https://leafletjs.com) (mappa)
|
||||
- [kalisio/leaflet-graphicscale](https://github.com/kalisio/leaflet-graphicscale) (plugin Leaflet per scala mappa)
|
||||
- [Leaflet/Leaflet.markercluster](https://github.com/Leaflet/Leaflet.markercluster) (plugin Leaflet per raggruppamenti puntatori)
|
||||
- [Spotlight.js](https://nextapps-de.github.io/spotlight/) (gallery immagini)
|
||||
- [Photo Sphere Viewer](https://photo-sphere-viewer.js.org/) (foto sferiche / panorami)
|
||||
- [Stimulus](https://stimulus.hotwired.dev) (UI)
|
||||
|
||||
## TODO
|
||||
|
||||
- [ ] Auto-discovery per Stimulus?
|
||||
- [ ] Refactor con app state per evitare oggetti globali
|
Loading…
Reference in New Issue
Block a user