README

Il software gestionale open-source per l'assistenza tecnica e la fatturazione.

Sito web · Documentazione · Forum

Il gestionale OpenSTAManager è un software open-source e web based, sviluppato dall'azienda informatica DevCode di Este per gestire ed archiviare il servizio di assistenza tecnica e la relativa fatturazione. Il nome del progetto deriva dalla parziale traduzione in inglese degli elementi principali che lo compongono: la natura open-source e il suo obiettivo quale Gestore del Servizio Tecnico di Assistenza.

Un software gestionale, identificato nell'insieme degli applicativi che automatizzano i processi di gestione all'interno delle aziende, appartiene solitamente a una specifica categoria del settore, specializzata negli ambiti di:

• Gestione della contabilità;
• Gestione del magazzino;
• Gestione e ausilio della produzione;
• Gestione e previsione dei budget aziendali;
• Gestione ed analisi finanziaria.

Secondo questa definizione, OpenSTAManager riesce a generalizzare al proprio interno le funzionalità caratteristiche della contabilità e della gestione del magazzino, presentando inoltre moduli piuttosto avanzati e destinati a complementare l'attività aziendale in relazione agli interventi di assistenza della realtà lavorativa in oggetto.

La documentazione ufficiale è disponibile all'indirizzo https://docs.openstamanager.com/.

• Requisiti
• Installazione
  • Versioni
  • Build
  • Strumenti di sviluppo e debug
• Perché software open-source
• Community
• Contribuire
• Sviluppatori
• Licenza

Requisiti software

L'installazione del gestionale richiede la presenza di un server web con abilitato il DBMS MySQL (o MariaDB >= 10.5) e il linguaggio di programmazione PHP.

Fonte EOL PHP: https://endoflife.date/php

Fonte EOL MySQL: https://endoflife.date/mysql

Fonte EOL MariaDB: https://endoflife.date/mariadb

❗Alcune dipendenze presenti dalla versione 2.5 non sono più compatibili con PHP 7.4 e PHP 8.0, dalla versione 2.5.3 sarà quindi richiesta una versione di php >= 8.1.

❗Alcune dipendenze presenti dalla versione 2.11 non sono più compatibili con PHP 8.1, dalla versione 2.11 sarà quindi richiesta una versione di php >= 8.3.

Per ulteriori informazioni, visitare la sezione Installazione della documentazione.

Requisiti hardware

Minimi:

• 1 CPU
• 2GB di ram
• 200MB di spazio per il gestionale

Consigliati:

• 2 CPU
• 4GB di ram
• 2GB di spazio per il gestionale

Installazione rapida

git clone https://github.com/devcode-it/openstamanager.git
cd openstamanager

# Download di composer da https://getcomposer.org/download/

yarn develop-OSM

Installazione

Per procedere all'installazione è necessario seguire i seguenti punti:

1. Scaricare una release ufficiale del progetto.

2. Creare una cartella (ad esempio openstamanager) nella root del server web installato ed estrarvi il contenuto della release scaricata. Il percorso della cartella root del server varia in base al software in utilizzo:

   • LAMP (/var/www/html)
   • XAMPP (C:/xampp/htdocs per Windows, /opt/lampp/htdocs/ per Linux, /Applications/XAMPP/htdocs/ per MAC)
   • WAMP (C:\wamp\www)
   • MAMP (C:\MAMP\htdocs per Windows, /Applications/MAMP/htdocs per MAC)

3. Creare un database vuoto (tramite PHPMyAdmin o riga di comando).

4. Accedere a http://localhost/openstamanager dal vostro browser.

5. Inserire i dati di configurazione per collegarsi al database.

6. Procedere all'installazione del software, cliccando sul pulsante Installa.

Attenzione: è possibile che l'installazione richieda del tempo. Si consiglia pertanto di attendere almeno qualche minuto senza alcun cambiamento nella pagina di installazione (in particolare, della progress bar presente) prima di cercare una possibile soluzione nelle discussioni del forum o nella sezione dedicata.

Versioni

Per mantenere un elevato grado di trasparenza riguardo al ciclo delle release, seguiamo le linee guida Semantic Versioning (SemVer) per definire le versioni del progetto. Per vedere tutte le versioni disponibili al download, visitare la pagina relativa su GitHub (per versioni precedenti alla 2.3, visitare SourceForge).

Nel caso utilizziate il programma per uso commerciale, si consiglia di scaricare le release disponibili nel sito ufficiale del progetto (https://www.openstamanager.com), evitando di utilizzare direttamente il codice della repository. Se siete inoltre interessati a supporto e assistenza professionali, li potete richiedere nella sezione dedicata.

Build

Nel caso si stia utilizzando la versione direttamente ottenuta dalla repository di GitHub, è necessario eseguire i seguenti comandi da linea di comando per completare le dipendenze PHP (tramite Composer) e gli assets (tramite Yarn) del progetto.

php composer.phar install
yarn global add gulp
yarn install
gulp

In alternativa alla sequenza di comandi precedente, è possibile utilizzare il seguente comando (richiede l'installazione di GIT e Yarn, oltre che l'inserimento dell'archivio composer.phar nella cartella principale del progetto):

yarn run develop-OSM

Per ulteriori informazioni, visitare le sezioni Assets e Framework della documentazione.

Docker

E' disponibile un'immagine Docker con Apache e MySQL preconfigurati con PHP 8.3. Per creare un container con l'ultima versione in sviluppo è necessario eseguire questi comandi:

docker compose up --build -d

IMPORTANTE:

• al momento viene scaricata sempre la versione all'ultimo commit che può non essere stabile
• è suggerito cambiare i dati di connessione al database contenuti nel file docker/docker-compose.yml (almeno DB_PASSWORD)

Strumenti di sviluppo e debug

Riepilogando, per compilare occorre installare i seguenti strumenti:

• php >= 8.5 con estensioni:
  • php-curl
  • php-dom
  • php-intl
  • php-json
  • php-xml
  • php-mbstring
  • php-pdo
  • php-xml
  • php-xsl
  • php-zip
• composer v2: https://getcomposer.org/download/
• nodejs >= v22: https://nodejs.org/en/learn/getting-started/how-to-install-nodejs
• yarn >= v4.6.0: https://classic.yarnpkg.com/en/docs/install
• gulp v4: https://gulpjs.com/docs/en/getting-started/quick-start/#install-the-gulp-command-line-utility

Consigliamo di installare psalm e configurarlo nel proprio IDE se supportato, in modo che vengano eseguiti ulteriori controlli automatici sul codice scritto.

E' già configurato su composer l'inclusione di PHP-CS-Fixer, uno strumento che permette di formattare in modo uniforme il codice scritto. Si può configurare nel proprio IDE se supportato. Il percorso dell'eseguibile è vendor/bin/php-cs-fixer.

Perché software open-source

Il progetto è un software open-source perché permette agli utilizzatori di studiarne il funzionamento ed adattarlo alle proprie esigenze; inoltre, in ambito commerciale, non obbliga l'utilizzatore ad essere legato allo stesso fornitore di assistenza.

In questo modo è possibile ottenere un'ulteriore garanzia sul funzionamento del software, poiché chiunque ne abbia le capacità può verificarlo, escludendo mancanze in relazione alla sicurezza e alla privacy dei dati (caratteristica che il software proprietario non può offrire).

Community

La community è una componente importante in un progetto open-source, perché mette in contatto utenti e programmatori tra di loro e permette pertanto l'individuazione di soluzioni innovative e migliori.

Siamo presenti su Facebook, Instagram, X, YouTube, Telegram e Mastodon e il nostro forum ufficiale è disponibile all'indirizzo https://forum.openstamanager.com, dove potete segnalare i vostri problemi e soddisfare le vostre curiosità nelle sezioni più adeguate.

Contribuire

Per poter contribuire ed eseguire i test automatici, si consiglia di seguire le indicazioni descritte all'interno della documentazione ufficiale.

Se volete contribuire attivamente con semplici migliorie o correzioni potete cercare tra le issue per i nuovi contributori.

Licenza

Questo progetto è tutelato dalla licenza GPL 3.

Si richiede che qualsiasi distribuzione del software (o di sue versioni modificate) includa una copia del codice sorgente completo, una menzione adeguata al software originale OpenSTAManager e una copia della licenza GPL 3.

Star History