ruscomap/README.md

340 lines
11 KiB
Markdown
Raw Normal View History

2024-08-18 17:03:41 +02:00
# RuscoMap
2024-08-17 01:19:31 +02:00
2024-08-19 00:05:39 +02:00
_Una mappa della propria città dove utenti in anonimo possono inserire dei marker con nome, descrizione e foto del'oggetto abbandonato, segnalandolo a tutti i visitatori della mappa._
<br> Sulla falsa riga del "_te lo regalo se vieni a prenderlo_", questo è più il "_segnalo che c'è sta roba lì, è tua se te la vai a prendere_"
2024-08-18 16:53:56 +02:00
2024-08-19 02:25:51 +02:00
### ToDo per essere funzionale alla versione 0.1
2024-06-30 23:01:33 +02:00
2024-08-19 00:36:19 +02:00
- [x] Aggiungere il marker (visivo) al clic di inserimento marker [[commit f611832592](https://git.lattuga.net/scossa/ruscomap/commit/f6118325925ba91173cf5bcc0a206b85fa3ef1a3)]
2024-08-19 01:12:10 +02:00
- [x] Al momento si possono aggiungere infiniti marker (temporanei), da fixare [[commit 0fba9efe99](https://git.lattuga.net/scossa/ruscomap/commit/0fba9efe99057119ef5eedec078987482a193fea)]
2024-08-19 02:25:51 +02:00
### ToDo per essere funzionale alla versione 0.2
2024-08-19 02:21:17 +02:00
- [ ] ~~Cancellare i marker creati > di 24h (sia record db che img)~~ [[commit 78d4b6b216](https://git.lattuga.net/scossa/ruscomap/commit/78d4b6b2169d43550aa3af800ac2f946ebeb9743)]
- [ ] Rimuovere pezzi di codice js per cancellare marker creati > di 24h. Dovrebbe essere solo il [commit 78d4b6b216](https://git.lattuga.net/scossa/ruscomap/commit/78d4b6b2169d43550aa3af800ac2f946ebeb9743)
2024-08-19 02:25:51 +02:00
- [x] Scrivere script bash (<code>delete_rusco.sh</code>) che cancella tutti marker [[commit c0c4ee99e9](https://git.lattuga.net/scossa/ruscomap/commit/c0c4ee99e9262624ca86a1501429a85890452478)]
- [x] Scrivere script bash (<code>pulisci_vecchio_rusco.sh</code>) che cancella tutti marker più vecchi di 24h (automatico) [[commit c0c4ee99e9](https://git.lattuga.net/scossa/ruscomap/commit/c0c4ee99e9262624ca86a1501429a85890452478)]
2024-08-19 02:56:34 +02:00
- [ ] Come mettere nel cron del server lo script che cancella i marker più vecchi di 24h
2024-08-19 02:25:51 +02:00
- [x] Scrivere script bash (<code>pulisci_manualmente_vecchio_rusco.sh</code>) che cancella tutti marker più vecchi di 24h (manuale) [[commit c0c4ee99e9](https://git.lattuga.net/scossa/ruscomap/commit/c0c4ee99e9262624ca86a1501429a85890452478)]
2024-08-19 02:21:17 +02:00
- [ ] pushare e spostare script in cartella <code>/script</code>
2024-08-19 01:11:08 +02:00
2024-08-19 02:25:51 +02:00
### ToDo per essere funzionale alla versione 0.3
2024-08-17 14:09:47 +02:00
2024-08-19 01:11:08 +02:00
- [x] Implementare il bottone in alto a dx: quando premuto per passare alla modalità inserimento diventa una _X rossa_ che se premuta annulla l'inserimento marker [[commit fa82dc221e](https://git.lattuga.net/scossa/ruscomap/commit/fa82dc221e2e8d1648c78534c0320bd099f897f0)]
- [ ] A marker aggiunto con successo come icona del bottone in alto a dx rimane la X rossa (in modalità inserimento marker) invece di ritornare l'icona del marker (ovvero passare in modalità normale/visualizzazione)
2024-08-19 00:34:58 +02:00
2024-08-19 02:25:51 +02:00
### ToDo per essere funzionale alla versione 0.4
2024-08-19 00:34:58 +02:00
2024-08-19 00:53:52 +02:00
- [ ] Mostrare data/ora pubblicazione del marker per far capire al visitatore quanto tempo fa è stato avvistato il rusco
2024-08-19 00:36:19 +02:00
- [ ] Al momento sul marker temporaneo si vede l'immagine rotta. fixare: sul temporaneo non bisogna mostrare nulla
2024-08-19 00:34:58 +02:00
2024-08-19 02:25:51 +02:00
### ToDo per essere funzionale alla versione 0.5
2024-08-19 00:34:58 +02:00
2024-08-19 00:53:52 +02:00
- [ ] Riformattare visualizzazione form inserimento marker per mobile
2024-08-19 00:36:19 +02:00
- [ ] Milgiorare css del form inserimento dati marker
2024-08-19 00:34:58 +02:00
2024-08-19 02:25:51 +02:00
### ToDo per essere funzionale alla versione 0.6
2024-08-19 00:34:58 +02:00
2024-08-19 00:53:52 +02:00
- [ ] Creare form per ricercare tra i titoli/descrizioni dei marker esistenti (query esempio: "divano")
2024-08-19 00:34:58 +02:00
2024-08-19 02:25:51 +02:00
### ToDo per essere funzionale alla versione 0.7
2024-08-19 00:34:58 +02:00
2024-08-19 01:11:08 +02:00
- [ ] Pop-Up all'apertura di ruscomap con descrizione breve
- [ ] Scrivere il tutorial utente di ruscomap
- [ ] Creare pagina tutorial
- [ ] Link alla pagina del tutorial nel PopUp iniziale
2024-08-19 02:56:34 +02:00
### ToDo per essere funzionale alla versione 0.8
- [ ] Creare bottone per form/pagina "area riservata"/"accedi"
- [ ] Creare form/pagina "area riservata"/"accedi" per far accedere l'admin
- [ ] Creare ruolo Admin
- [ ] Permessi: Visita mappa, Aggiungi marker, Cancella Marker.
- [ ] Quando autenticati come admin mostrare un pulsante affianco/sopra/dentro al form dei dati del marker che ha la funzione di cancellare il marker corrispondente
- [ ] Popup che chiede la conferma della cancellazione del marker
2024-08-19 01:31:57 +02:00
2024-08-19 02:56:34 +02:00
### ToDo per essere funzionale alla versione 0.9
- [ ] Aggiungere ai permessi admin l'accesso al pannello admin.
- [ ] Creare Pannello Admin da dove poter creare utenti (nomeutente/password, no mail o altro)
2024-08-19 00:53:52 +02:00
- [ ] Gestione autenticazione utenti con password
2024-08-19 02:56:34 +02:00
### ToDo per essere funzionale alla versione 1.0
- [ ] Creare (?) Ruolo Ospite. Permessi: Visita mappa
- [ ] Creare Ruolo Utente. Permessi: Visita mappa, Aggiungi marker
#### Possibili altre implementazioni
2024-08-19 00:53:52 +02:00
- [ ] Scatta la foto del marker da uploadare direttamente in app (su alcuni smartphone gia lo fa)
- [ ] Inserire la posizione del marker tramite il gps dello smartphone
2024-08-19 00:36:19 +02:00
- [ ] Possibilità di aggiungere piu di una foto per un marker
2024-08-19 02:25:51 +02:00
- [x] Standardizzare gli script con controllo "myusername"
2024-08-19 02:21:17 +02:00
- [ ] Standardizzare con le varialibili del <code>default.json</code> gli script
- [ ] File config per popolare default.json e gli script
2024-08-19 01:11:08 +02:00
- [ ] Logo RuscoMap
2024-08-17 17:06:44 +02:00
2024-08-19 02:56:34 +02:00
### ToDo per essere funzionale alla versione 1.1
- [ ] Creare Ruolo Moderatore. Permessi : Visita mappa, Aggiungi marker, Cancella Marker
### ToDo per essere funzionale alla versione 1.2
- [ ] Feature da pannello admin: poter settare permessi personalizzati ai vari Ruoli (magari si vuole dare l'inserimento anche agli ospiti e/o la cancellazione dei marker agli user)
### ToDo per essere funzionale alla versione 1.3
- [ ] Creare form registrazione con mail
- [ ] Richiedere conferma mail via link spedito a l'indirizzo
2024-08-18 16:53:56 +02:00
<br>
---
2024-08-18 00:44:43 +02:00
<br><br>
2024-08-17 17:06:44 +02:00
2024-08-18 16:47:06 +02:00
# ISTRUZIONI INSTALLAZIONE
2024-08-18 00:44:43 +02:00
2024-08-18 16:47:06 +02:00
## Installazione dipendenze
2024-08-18 01:16:05 +02:00
#### Installa mariadb
<code>sudo apt update && sudo apt install mariadb</code>
#### Installa node e nvm
2024-08-18 00:44:43 +02:00
Curl da sito ufficiale [qui](https://github.com/nvm-sh/nvm?tab=readme-ov-file#install--update-script) <br>
_trobleshooting: cerca nvm in .bashrc_
2024-08-18 01:16:05 +02:00
## Installazione ruscomap
2024-08-18 17:03:41 +02:00
#### Clona il git
2024-08-18 00:44:43 +02:00
```
# crea la cartella
mkdir /var/www/html/leaflet/; cd /var/www/html/leaflet/;
# clona il repo
2024-08-18 17:33:30 +02:00
git clone https://git.lattuga.net/scossa/ruscomap.git
2024-08-18 00:44:43 +02:00
```
2024-08-18 17:03:41 +02:00
#### Personalizza il file di configurazione db
2024-08-18 00:44:43 +02:00
<code>nano /var/www/html/leaflet/ruscomap/config/default.json</code>
2024-08-18 17:03:41 +02:00
#### Inizializza db
2024-08-18 00:44:43 +02:00
```
# usa la versione node spcificata nel file .nvmrc
cd /var/www/html/leaflet/ruscomap/; nvm use
# sempre da cartella git
cd /var/www/html/leaflet/ruscomap/;
2024-08-18 17:35:11 +02:00
# inzializza Db
mysql < intDb.sql
2024-08-18 00:44:43 +02:00
```
2024-08-18 17:03:41 +02:00
#### Apri porta sul firewall
2024-08-18 16:47:06 +02:00
<code>sudo iptables -A INPUT -p tcp --dport 3000 -j ACCEPT</code>
2024-08-18 00:44:43 +02:00
2024-08-18 17:03:41 +02:00
#### Crea il servzio
2024-08-18 00:46:25 +02:00
<code>nano /etc/systemd/system/ruscomap.service</code>
2024-08-18 00:44:43 +02:00
```
[Unit]
Description=Ruscomap Service
After=network.target
[Service]
2024-08-18 17:32:32 +02:00
User=<utente_del_config/default.json>
2024-08-18 00:44:43 +02:00
WorkingDirectory=/var/www/html/leaflet/ruscomap/
ExecStart=/bin/bash -c "node index.js"
Restart=always
RestartSec=5
[Install]
WantedBy=multi-user.target
```
2024-08-18 17:09:34 +02:00
##### avvialo e abilitalo a startarsi in automatico
```
sudo systemctl start ruscomap.service
sudo systemctl enable ruscomap.service
```
2024-08-18 00:44:43 +02:00
2024-08-18 17:03:41 +02:00
#### Crea il file conf di apache
2024-08-18 00:44:43 +02:00
<code>nano /etc/apache2/site-enabled/ruscomap.conf</code>
```
#PORT 80 RUSCOMAP
2024-08-18 16:47:06 +02:00
<VirtualHost ruscomap.myserver.it:80>
2024-08-18 00:44:43 +02:00
DocumentRoot /var/www/html/leaflet/ruscomap/public
2024-08-18 16:47:06 +02:00
ServerName ruscomap.myserver.it
2024-08-18 00:44:43 +02:00
ProxyPass / http://localhost:3000/
ProxyPassReverse / http://localhost:3000/
RewriteEngine on
RewriteCond %{HTTP:Upgrade} =websocket
RewriteRule /(.*) ws://localhost:3000/$1 [P,L]
ErrorLog ${APACHE_LOG_DIR}/ruscomap.log
CustomLog ${APACHE_LOG_DIR}/ruscomap-access.log combined
</VirtualHost>
```
2024-08-18 17:09:34 +02:00
##### restarta apache
```
sudo systemctl restart apache2.service
```
2024-08-18 00:44:43 +02:00
<br>
2024-08-18 16:47:06 +02:00
# ISTRUZIONI ADMIN
2024-08-19 02:21:17 +02:00
## Script per cancellare tutti i record della table "markers" più vecchi di 24h (automatico)
2024-08-19 01:31:57 +02:00
2024-08-19 02:21:17 +02:00
<code>nano /var/www/html/leaflet/ruscomap/pulisci_vecchio_rusco.sh</code>
2024-08-19 01:31:57 +02:00
```
2024-08-19 02:21:17 +02:00
#!/bin/bash
2024-08-19 01:31:57 +02:00
2024-08-19 02:21:17 +02:00
# Database credentials
DB_USER="myusername"
DB_PASS="mypassword"
DB_NAME="ruscomap"
TABLE_NAME="markers"
# Controlla se DB_USER è "myusername"
if [ "$DB_USER" == "myusername" ]; then
echo -e "\nDevi impostare nome utente e password per usare lo script"
echo -e "editalo con nano pulisci_vecchio_rusco.sh"
exit 0
fi
# Prendi l'ora e data meno 24 ore
TIME_THRESHOLD=$(date -d '24 hours ago' '+%Y-%m-%d %H:%M:%S')
# comando sql che cancella i record piu vecchi di 24h
SQL_COMMAND="DELETE FROM $TABLE_NAME WHERE ts < '$TIME_THRESHOLD';"
esegue il comando Execute the SQL command
mysql -u "$DB_USER" -p"$DB_PASS" "$DB_NAME" -e "$SQL_COMMAND"
# check del comando
if [ $? -eq 0 ]; then
echo "Rusco più vecchi di 24h cancellato."
else
echo "\ERRORE!\n"
2024-08-19 01:31:57 +02:00
```
2024-08-19 02:21:17 +02:00
#### Imposta lo script su cron per essere eseguito ogni 24h
2024-08-19 01:31:57 +02:00
```
```
2024-08-19 02:21:17 +02:00
## Script per cancellare tutti i record della table "markers" più vecchi di 24h (manuale)
2024-08-19 02:28:22 +02:00
<code>nano /var/www/html/leaflet/ruscomap/pulisci_manualmente_vecchio_rusco.sh</code>
2024-08-19 02:21:17 +02:00
```
#!/bin/bash
# Database credentials
DB_USER="myusername"
DB_PASS="mypassword"
DB_NAME="ruscomap"
TABLE_NAME="markers"
# Controlla se DB_USER è "myusername"
if [ "$DB_USER" == "myusername" ]; then
echo -e "1nDevi impostare nome utente e password per usare lo script"
echo -e "editalo con nano pulisci_vecchio_rusco.sh"
exit 0
fi
# Mostra dati impostati
echo -e "\nDati impostati:"
echo -e "$DB_USER"
echo -e "$DB_PASS"
echo -e "$DB_NAME"
echo -e "$TABLE_NAME"\n
# Chiedi all'utente se i dati sono giusti
read -p "I dati sono giusti? Vuoi continuare? (y/yes/s/si): " user_input
# Converti l'input in minuscolo
user_input_lower=$(echo "$user_input" | tr '[:upper:]' '[:lower:]')
# Controlla se l'input è uno dei valori accettabili
if [[ "$user_input_lower" == "y" || "$user_input_lower" == "yes" || "$user_input_lower" == "s" || "$user_input_lower" == "si" ]]; then
echo -e "Cancello la table $TABLE_NAME..."
# Prendi l'ora e data meno 24 ore
TIME_THRESHOLD=$(date -d '24 hours ago' '+%Y-%m-%d %H:%M:%S')
# comando sql che cancella i record piu vecchi di 24h
SQL_COMMAND="DELETE FROM $TABLE_NAME WHERE ts < '$TIME_THRESHOLD';"
esegue il comando Execute the SQL command
mysql -u "$DB_USER" -p"$DB_PASS" "$DB_NAME" -e "$SQL_COMMAND"
# check del comando
if [ $? -eq 0 ]; then
echo "Rusco più vecchi di 24h cancellato."
else
echo "\nErrore!\n"
fi
```
2024-08-18 16:47:06 +02:00
## Cancella un record del db
```
2024-08-18 17:32:32 +02:00
mariadb -u <utente_del_config/default.json> -p
2024-08-18 16:47:06 +02:00
show databases;
use ruscomap;
show tables;
select * from markers;
DELETE FROM markers WHERE filename = '0a9f02167f85c845db2d4b81bbeef9d5';
```
## Script per aggiornare ruscomap
2024-08-18 00:44:43 +02:00
<code>nano /var/www/html/leaflet/ruscomap/AggiornaRuscoMap.sh</code>
```
echo -e "Stoppo ruscomap..."
systemctl stop ruscomap.service
sleep 1
cd /var/www/html/leaflet/ruscomap
echo -e "\nEseguo git pull..."
git pull
sleep 1
echo -e "Do permessi www-data..."
chown -R www-data:www-data /var/www/html/leaflet/ruscomap/public
echo -e "restarto apache e ruscmap"...
systemctl restart apache2.service
systemctl start ruscomap.service
echo -e "Aggiornamento completato!\n"
2024-08-19 01:31:57 +02:00
```
2024-08-19 02:21:17 +02:00
## Script per cancellare tutti i record della table "markers"
2024-08-19 01:31:57 +02:00
<code>nano /var/www/html/leaflet/ruscomap/delete_rusco.sh</code>
```
#!/bin/bash
# Define database credentials
DB_USER="myuser"
2024-08-19 02:21:17 +02:00
DB_PASS="mypassword"
2024-08-19 01:31:57 +02:00
# Connect to MariaDB and execute commands
mariadb -u "$DB_USER" -p"$DB_PASS" <<EOF
USE ruscomap;
TRUNCATE TABLE markers;
EOF
2024-08-18 00:44:43 +02:00
```