Add README

This commit is contained in:
Nicolò P. 2024-11-28 08:08:44 +01:00
parent b75a1b7912
commit 9954c797e0

40
README.md Normal file
View File

@ -0,0 +1,40 @@
# WebGIS Isola di Capri
Il webGIS è servito dalla cartella `webgis/`, che funziona da _root_ per i file JavaScript (cartella `js/`), caricati dal relativo `index.html`, oltre che per immagini, documenti e layer GeoJSON.
## Configurazione
Il webGIS necessita di un singolo file di configurazione (**_non versionato_**), che deve trovarsi in `webgis/js` ed essere nominato `config.js`.
Il file definisce solo gli endpoint di base da utilizzare per le chiamate alla API JSON lato server (che fornisce dati estratti dal database PostgreSQL) in ambiente di sviluppo (`dev`) o in produzione (`prod`).
La struttura del file deve essere la seguente (gli endpoint riportati sono solo di esempio):
```js
const API_CONFIG = {
dev: 'https://localhost',
prod: 'https://api.example.com'
};
export default API_CONFIG;
```
## Dipendenze
Le dipendenze sono gestite con `yarn`, per installarle è sufficiente eseguire `yarn` dalla cartella `webgis/js`, dove si trova `package.json`.
Il file `webgis/index.html` contiene una [`importmap`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script/type/importmap) principalmente per mappare
Photo Sphere Viewer, Three.js (da cui dipende Photo Sphere Viewer) e Stimulus.
### CSS
- [Bulma](https://bulma.io)
- Fontawesome free
### JS
- [Leaflet](https://leafletjs.com) (mappa)
- [kalisio/leaflet-graphicscale](https://github.com/kalisio/leaflet-graphicscale) (plugin Leaflet per scala mappa)
- [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)