netgescon-day0/README.md

42 lines
1.2 KiB
Markdown

# NetGesCon (Laravel + Filament)
## Panoramica
Gestione condominiale con moduli contabili, anagrafiche e archivi legacy. Stack principale: Laravel + Filament + Livewire.
## Requisiti
- PHP 8.3+
- Composer
- Node.js + npm
- MySQL/MariaDB
## Avvio rapido (sviluppo)
1) Crea il file `.env` da `.env.example` e configura DB/APP_URL
2) Installa dipendenze
- `composer install`
- `npm install`
3) Genera la chiave app
- `php artisan key:generate`
4) Migra il DB
- `php artisan migrate`
5) Asset Filament
- `php artisan filament:assets`
6) Avvio
- `php artisan serve`
## Distribuzione Open Source (linee guida)
- Aggiungi una licenza: `LICENSE` (MIT, Apache-2.0, AGPL, ecc.)
- Compila la documentazione essenziale:
- `README.md` (setup, requisiti, run)
- `CONTRIBUTING.md` (workflow PR, coding standards, test)
- `CHANGELOG.md` (note di rilascio)
- Evita dati sensibili nel repository:
- Non versionare `.env` reali
- Rimuovi credenziali e chiavi
- Versiona con tag semantici: `vX.Y.Z`
## Struttura documentazione
- `docs/` contiene i flussi, import, troubleshooting e procedure operative.
## Contribuire
Vedi `CONTRIBUTING.md` (da aggiungere) per le regole di collaborazione.