SM - Sport Management

---

Anno Scolastico: 2024/2025

Studente: Attene Davide

Istituto Scolastico: I.T.T. "Attilio Deffenu" - Olbia

---

Descrizione

Il progetto SM - Sport Management mira alla realizzazione di una Web App Responsive per un'associazione sportiva.

Le attività da svolgere e i task assegnati fanno riferimento al progetto PCTO - Deffenu Informatica 2024/2025

Le principali funzionalità implementate includono:

• Gestione anagrafiche (atleti, allenatori, medici sportivi)
• Gestione documentale (certificazioni medico sportive)
• Gestione pagamenti (compensi allenatori)

Documentazione API disponibili al seguente link:
https://pcto-deffenu.vercel.app/api/swagger/

Struttura Progetto

Di seguito una breve descrizione della struttura del progetto:

Cartella/File	Descrizione
manage.py	Script di gestione del progetto Django.
requirements.txt	Elenco delle dipendenze Python del progetto.
README.md	Documentazione e linee guida del progetto.

Avvio del Progetto

Clonare il Repository

git clone https://github.com/username/pcto-deffenu-informatica-backend.git
cd pcto-deffenu-informatica-backend

Creare il file .env.local nella root del progetto con le seguenti Variabili d'ambiente:

# Development
SECRET_KEY=your-django-secret-key
DEBUG=True
ENVIRONMENT=development

Creare un ambiente virtuale ed attivarlo

python -m venv nome_ambiente_virtuale
source nome_ambiente/bin/activate		# Linux/Mac
nome_ambiente\Scripts\activate			# Windows

Installare le Dipendenze

pip install -r requirements.txt

Effettuare le Migrazioni

python manage.py migrate

Avviare il Server di Sviluppo

python manage.py runserver

API disponibili

Le API sono documentate in modo interattivo con Swagger. Una volta avviato il server, puoi accedere alla documentazione all'indirizzo: http://localhost:8000/api/swagger/

Contribuzione

Trattandosi di un progetto open-source è aperto anche a contribuzioni esterne. Se qualcuno fosse interessato, dopo aver creato una issue nel presente repository, può attendere l'assegnazione del task ed eventualmente procedere poi con l'implementazione di quanto approvato.

Per prima cosa effettuare il fork del repository e clonarlo localmente con il seguente comando:

# HTTPS
git clone https://github.com/username/pcto-deffenu-informatica-backend.git

oppure

SSH
git clone git@github.com:username/pcto-deffenu-informatica-backend.git

Questo comando genererà una folder/directory con lo stesso nome del repository, all'interno del quale spostarsi con il comando:

cd pcto-deffenu-informatica-backend

Avviare quindi il proprio IDE per visualizzare la codebase del progetto. Per contribuire creare immediatamente un nuovo branch partendo dal 'main' (branch principale) con il comando:

git checkout -b username-feature-da-implementare

A questo punto ci si troverà posizionati direttamente nel nuovo branch e sarà pertanto possibile apportare tutte le modifiche o nuove feature desiderate. Nel momento in cui si vuole far si che queste possano entrare a far parte della codebase principale, procedere nel seguente modo:

# Usare iterativamente lo stesso comando per tutti i file modificati
git add nome-file-modificato

E' anche possibile adottare un comando che ne permette l'aggiunta automatica di tutti i file, ma bisogna prestare maggiore attenzione in quanto saranno aggiunti all'area di staging tutti i file, inclusi magari quelli che non dovrebbero. Il comando è il seguente:

# Prestare la massima attenzione
git add .

Successivamente è quindi possibile effettuare il commit dei file con il seguente comando:

git commit -m "messaggio-di-commit"

ed infine inviare il tutto al proprio repository remoto (di cui si è fatto precedentemente il fork) con il comando:

git push origin username-feature-da-implementare

Andare quindi al proprio repository remoto, ed aprire una Pull Request (bottone verde Compare and Pull Request) dal branch username-feature-da-implementaredel proprio repository verso il main del repository originale.

Attendere quindi che la PR venga approvata, rifiutata o richieda modifiche da apportare.

Se approvata, recarsi nuovamente nel proprio repository remoto ed effettuare la sincronizzazione del proprio main con quello del repository originale (dove è stato effettuato il merge della Pull Request).

Viceversa se vengono richieste delle modifiche, recarsi nuovamente nel proprio branch locale, effettuare le modifiche richieste ed eseguire nuovamente i comandi add , commit and push al fine di integrare la Pull Request con quanto precedentemente richiesto.

Licenza

Per questa tipologia di progetto, è stata scelta la licenza MIT: https://en.wikipedia.org/wiki/MIT_License