1
0
mirror of https://github.com/devcode-it/openstamanager.git synced 2024-12-23 22:03:18 +01:00
openstamanager/README.md
Thomas Zilio 273372dbdc Miglioramento della documentazione automatica
Miglioramento del processo di documentazione automatica per il branch gh-pages, con generalizzazione della struttura della classe Auth.
Aggiunto sistema per la formattazione automatica del codice sfruttanto PHP CS Fixer (https://github.com/FriendsOfPHP/PHP-CS-Fixer).
2017-08-07 13:07:18 +02:00

8.5 KiB

OpenSTAManager

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 risulta disponibile all'indirizzo https://devcode-it.github.io/openstamanager/.

Requisiti

Prima di iniziare l'installazione, è necessario procedere al download di una versione del progetto da Github. Si consiglia inoltre di controllare che i prerequisiti del software, elencati di seguito, siano soddisfatti.

L'installazione del gestionale richiede la presenza di un server web con abilitato il DBMS (Database Management System) MySQL e il linguaggio di programmazione PHP.

  • PHP >= 5.4 (si consiglia la versione 5.6 per poter usufruire di tutte le funzionalità del progetto)
  • MySQL >= 5.0

Per ulteriori informazioni sui pacchetti che forniscono questi elementi di default, visitare la sezione Installazione della documentazione.

Installazione

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

  1. Creare una cartella (ad esempio openstamanager) nella root del sever 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).
  2. Creare un database vuoto (tramite PHPMyAdmin o riga di comando).

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

  4. Inserire i dati per collegarsi al database e cliccare su Installa per completare l'installazione.

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).

Github

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 asssets (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.

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).

Nel caso utilizziate il programma per uso commerciale, si consiglia di non utilizzare le versioni ottenibili direttamente dalla repository su Github ma di scaricare le release ufficiali disponibili nel nostro sito ufficiale http://www.openstamanager.com; se siete inoltre interessati a supporto e assistenza professionali, li potete richiedere nella sezione dedicata.

Componenti esterni

OpenSTAManager è stato progettato utilizzando altro software open source, tra cui principalmente:

  • PHP - A popular general-purpose scripting language especially suited to web development
  • MySQL - The world's most popular open source database
  • JQuery - New Wave JavaScript
  • Bootstrap - The world's most popular mobile-first and responsive front-end framework
  • FontAwesome - The iconic font and CSS toolkit
  • HTML2PDF - HTML to PDF converter written in PHP

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, e il nostro forum ufficiale è disponibile all'indirizzo http://www.openstamanager.com/forum/, dove potete segnalare i vostri problemi e soddisfare le vostre curiosità nelle sezioni più adeguate:

Attenzione: vi ricordiamo che non vi è nessuna garanzia che qualcuno risponda in tempo alle vostre richieste o problemi.

Contribuire

Per poter contribuire, si consiglia di seguire le indicazioni descritte all'interno della documentazione ufficiale; in particolare, prestare attenzione al codice di condotta e allo stile del codice.

Sviluppatori

Per la lista completa delle persone che hanno partecipato al progetto, consultare la pagina principale della documentazione su Github.

Licenza

Questo progetto è tutelato dalla licenza GPL 3 (si veda LICENSE per ulteriori dettagli).