Code Phoenix : Hackaton Code Rebirth 2024
Oppure Docker e Docker Compose per l’installazione con Docker
Crea un ambiente virtuale Python:
python -m venv venv
source venv/bin/activate # Per Linux/macOS
venv\Scripts\activate # Per Windows
Installa le dipendenze del backend:
pip install -r requirements.txt
bin
al tuo PATH di sistemacd ./frontend_react
Installa le dipendenze del frontend:
npm install
Questo verrà usato per fare inferenza con modelli open source, alternativamente usabili anche in locale.
bin
dell’installazione di SonarQube:
./sonar.sh start
StartSonar.bat
Dopo aver avviato l’applicazione e aver visto nel terminale il messaggio SonarQube is operational
, segui questi passaggi per configurare SonarQube:
http://localhost:9000
admin
admin
.env
nella directory principale del progettoAggiungi la seguente riga, sostituendo <TUO_TOKEN_SONARQUBE>
con il token copiato:
SONARQUBE_TOKEN=<TUO_TOKEN_SONARQUBE>
.env
Avvia il backend:
uvicorn app:app --host 0.0.0.0 --port 60000
In un nuovo terminale, avvia il frontend:
cd frontend_react
npm run dev
Dopo aver configurato SonarQube e riavviato l’applicazione, puoi accedere al frontend dell’applicazione navigando nel tuo browser web a:
http://localhost:3000
Se non hai già Docker installato sul tuo sistema, segui questi passaggi:
Nella directory principale del progetto, esegui il seguente comando per costruire l’immagine Docker:
docker compose build
Questo comando costruirà tutte le immagini Docker necessarie per l’applicazione come specificato nel file docker-compose.yml
.
Una volta completata la costruzione dell’immagine, puoi avviare l’applicazione con il seguente comando:
docker compose up
Questo comando avvierà tutti i servizi definiti nel file docker-compose.yml
.
Dopo aver avviato l’applicazione e aver visto il messaggio SonarQube is operational
, segui questi passaggi per configurare SonarQube:
http://localhost:9000
admin
admin
.env
nella directory principale del progettoAggiungi la seguente riga, sostituendo <TUO_TOKEN_SONARQUBE>
con il token copiato:
SONARQUBE_TOKEN=<TUO_TOKEN_SONARQUBE>
.env
Dopo aver configurato SonarQube, per applicare le nuove configurazioni, fermare l’applicazione con Ctrl+C
, poi ricompilarla e riavviarla con il seguente comando:
docker compose build && docker compose up
Per ulteriori informazioni guardare la documentazione al link :
Per ulteriori dettagli sui vari microservizi del progetto, consulta i seguenti documenti:
Ecco la tabella aggiornata con il microservizio di documentazione:
Microservizio | Descrizione | Link alla Documentazione |
---|---|---|
Sistema di Analisi 🔍 | Analisi del codice | Documentazione Analisi |
Sistema di Test 💻 | Test automatici e integrazione continua | Documentazione Test |
Sistema di Scansione ⚡ | Scansione di sicurezza e vulnerabilità | Documentazione Scansione |
Sistema di Refactoring ⚙️ | Refactoring e miglioramento del codice | Documentazione Refactoring |
Sistema di Documentazione 📚 | Generazione di documentazione per il codice refattorizzato | Documentazione Documentazione |