openstamanager/README.md

194 lines
10 KiB
Markdown
Executable File

<div align="center">
<a href="https://openstamanager.com">
<!--suppress HtmlUnknownTarget -->
<img src="resources\static\images\logo_completo.png" alt="OpenSTAManager">
</a>
<p align="center">
Il software gestionale open-source per l'assistenza tecnica e la fatturazione.
<br>
<br>
<a href="https://www.openstamanager.com">Sito web</a>
·
<a href="https://docs.openstamanager.com/">Documentazione</a>
·
<a href="https://forum.openstamanager.com">Forum</a>
</p>
</div>
<br>
[![GitHub release](https://img.shields.io/github/release/devcode-it/openstamanager/all.svg)](https://github.com/devcode-it/openstamanager/releases)
[![Downloads](https://img.shields.io/github/downloads/devcode-it/openstamanager/total.svg)](https://github.com/devcode-it/openstamanager/releases)
[![SourceForge](https://img.shields.io/sourceforge/dt/openstamanager.svg?label=SourceForge)](https://sourceforge.net/projects/openstamanager/)
[![license](https://img.shields.io/github/license/devcode-it/openstamanager.svg)](https://github.com/devcode-it/openstamanager/blob/master/LICENSE)
[![huntr](https://cdn.huntr.dev/huntr_security_badge_mono.svg)](https://huntr.dev)
Il gestionale OpenSTAManager è un software open-source e web based, sviluppato dall'azienda
informatica [DevCode](https://www.devcode.it/) 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/](https://docs.openstamanager.com/).
## Requisiti
L'installazione del gestionale richiede un server web con le seguenti tecnologie disponibili:
- [PHP](https://php.net) 8.1+
- Un database a scelta tra:
- [MySQL](https://www.mysql.com) 5.7+ (consigliato) / [MariaDB](https://mariadb.org/) 10.3+
- [PostgreSQL](https://www.postgresql.org) 10.0+
- [SQLite](https://www.sqlite.org) 3.8.8+ (non consigliato, in quanto viene salvato "in chiaro" sul filesystem del
server)
- [SQL Server](https://www.microsoft.com/it-it/sql-server) 2017+
- Accesso SSH (**facoltativo, ma fortemente consigliato**)
- [Composer](https://getcomposer.org/) installato e disponibile da linea di comando (**facoltativo, ma fortemente consigliato**)
e un dispositivo (client) con le seguenti tecnologie disponibili:
- Browser moderno, a scelta tra:
- [Microsoft Edge](https://www.microsoft.com/it-it/edge) 83+
- [Google Chrome](https://www.google.com/intl/it_it/chrome/) 93+
- [Mozilla Firefox](https://www.mozilla.org/it/firefox/) 92+
- [Opera](https://www.opera.com) 79+
- [Safari](https://www.apple.com/it/safari/) (attualmente solo nella sua
versione [Technology Preview](https://developer.apple.com/safari/technology-preview/) 33+)
_Alcune note:_
- _**Non** è supportato nessun browser diverso dai precedenti, nemmeno in versioni più datate. Pertanto, anche se il
gestionale potrebbe funzionare, non è garantita assistenza su tali browser. Si citano come esempi: Internet Explorer,
Samsung Internet, Opera Mini, Opera Mobile, UC Browser, Safari per iOS._
- _È fortemente consigliato aggiornare sempre il proprio browser alla versione più recente e non interrompere la
ricezione degli aggiornamenti raggiunta la versione minima indicata_
- _Il gestionale viene testato sui 3 principali browser (Edge, Chrome, Firefox) nella loro versione più recente_
Per ulteriori informazioni sui pacchetti che forniscono questi elementi di default, visitare la
sezione [Installazione](https://docs.openstamanager.com/guide/configurazione/installazione) della documentazione.
### Dipendenze
Per installare le dipendenze del gestionale sono necessari i seguenti strumenti (installati sul server web o su un PC da utilizzare per la
preparazione del progetto):
- [Composer](https://getcomposer.org/)
- [Node.js](https://nodejs.org/) 18+
- [Git](https://git-scm.com/) (facoltativo, ma consigliato)
## Installazione
Per procedere all'installazione è necessario seguire i seguenti punti:
1. [Scaricare una release ufficiale del progetto](https://github.com/devcode-it/openstamanager/releases).
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](http://localhost/phpmyadmin/) o riga di comando).
4. Accedere a [http://localhost/openstamanager](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)](https://semver.org/) per definire le versioni del progetto. Per vedere tutte le
versioni disponibili al download, visitare la [pagina relativa](https://github.com/devcode-it/openstamanager/releases)
su GitHub (per versioni precedenti alla 2.3,
visitare [SourceForge](https://sourceforge.net/projects/openstamanager/files)).
Nel caso utilizziate il programma per uso commerciale, si consiglia di scaricare le release disponibili nel sito
ufficiale del progetto ([https://www.openstamanager.com](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](https://www.openstamanager.com/per-le-aziende/).
### 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](https://getcomposer.org)) e
gli assets (tramite [PNPM](https://pnpm.io/it)) del progetto.
#### Installazione delle dipendenze
```bash
composer install --no-dev
pnpm install --prod
pnpm build
```
Da qui si possono scegliere due strade:
#### Installazione da linea di comando
```bash
php artisan migrate
# TODO: Add a command to create the admin user
```
#### Installazione da interfaccia web
1. Avviare il server web o utilizzare il comando `php artisan serve` per avviare il server web integrato.
2. Accedere a [http://localhost/openstamanager](http://localhost/openstamanager) dal vostro browser.
3. Seguire la procedura guidata per l'installazione.
Per ulteriori informazioni, visitare le sezioni [Assets](https://docs.openstamanager.com/docs/base/assets)
e [Framework](https://docs.openstamanager.com/docs/base/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).
## 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](https://www.facebook.com/openstamanager), e il nostro forum ufficiale è disponibile
all'indirizzo [https://forum.openstamanager.com](https://forum.openstamanager.com), dove potete segnalare i vostri
problemi e soddisfare le vostre
curiosità nelle sezioni più adeguate:
- [Idee, suggerimenti e consigli](https://forum.openstamanager.com/viewforum.php?f=1)
- [Problemi con la prima installazione](https://forum.openstamanager.com/viewforum.php?f=2)
- [Sicurezza](https://forum.openstamanager.com/viewforum.php?f=3)
- [Altro tipo di assistenza](https://forum.openstamanager.com/viewforum.php?f=4)
- [Tutorial](https://forum.openstamanager.com/viewforum.php?f=5)
**Attenzione**: vi ricordiamo che non vi è nessuna garanzia che qualcuno risponda in tempo alle vostre richieste o
problemi.
## Contribuire
Per poter contribuire ed eseguire i test automatici, si consiglia di seguire le indicazioni descritte all'interno
della [documentazione ufficiale](https://github.com/devcode-it/openstamanager/blob/master/.github/CONTRIBUTING.md).
## Licenza
Questo progetto è tutelato dalla licenza [**GPL 3**](https://github.com/devcode-it/openstamanager/blob/master/LICENSE).