Installazione su server proprio

Tramite questa repo è possibile installare l'API su un proprio server NodeJS.

Sistema di aggiornamento

Il sistema di aggiornamento della API prevede un sistema di logging tramite un bot Telegram. Il bot serve, oltre che per essere notificati sullo stato dell'aggiornamento da remoto, sia per la risoluzione di eventuali problemi/conflitti occorsi durante il fetch automatico dei dati. Prima di poter installare l'API quindi, crea un bot Telegram tramite BotFather (Puoi chiamarlo come vuoi, il codice per il suo funzionamento è incluso in questa repo).

Prerequisti del server

• MySQL
• Node.js v15
  Verificalo con il comando

  node --version
  # v15.x.x

  Se il comando non viene trovato o la versione installato è precedente alla 15.0.0, procedi ad installare o aggiornare node scaricandolo dal sito ufficiale.

Procedura di installazione

• Nella cartella scelta scarica la presente repo o clonala con il comando

  git clone https://github.com/Samurai016/Comuni-ITA.git

• Crea un file chiamato environment.env con il seguente contenuto:

  TELEGRAM_CHAT=<Chat ID>
  BOT_KEY=<Token del bot>
  MYSQL_HOST=<Server MySQL>
  MYSQL_DATABASE=<Nome del database>
  MYSQL_USERNAME=<Username del database>
  

  • TELEGRAM_CHAT = è l'id della chat, più avanti nella guida ti verrà detto come compilarlo.
  • BOT_KEY = è il token del bot che ti viene fornito da BotFather al momento della creazione del bot, puoi anche ottenerla chiedendola direttamente a BotFather.
• Crea il database MySQL usando il file comuni-ita.sql.
• Avvia il primo aggiornamento dell'API usando il comando

  npm run update

• Invia al bot il comando /start, il bot ti risponderà con il tuo chat ID da inserire nel file environment.env.
• Aggiorna il file environment.env con il chat ID e riavvia l'aggiornamento per popolare il database.
• Una volta completato l'aggiornamento avvia l'API con il comando

  npm start

Ogni volta che vorrai aggiornare l'API ti basterà avviare il comando npm run update.