Add project documentation and AI development guidelines
This commit is contained in:
@@ -0,0 +1,37 @@
|
||||
# Architecture Summary
|
||||
|
||||
Frontend
|
||||
|
||||
- React
|
||||
- TanStack Start
|
||||
- Tailwind
|
||||
- TypeScript
|
||||
|
||||
Backend
|
||||
|
||||
- Supabase
|
||||
|
||||
Hosting
|
||||
|
||||
- Vercel
|
||||
|
||||
Repository
|
||||
|
||||
- GitHub
|
||||
|
||||
Branch
|
||||
|
||||
- main
|
||||
- develop
|
||||
|
||||
Documentazione
|
||||
|
||||
- docs/
|
||||
|
||||
Database
|
||||
|
||||
- Supabase
|
||||
|
||||
Storage
|
||||
|
||||
- Supabase Storage
|
||||
@@ -0,0 +1,12 @@
|
||||
# Coding Style
|
||||
|
||||
Preferenze del progetto.
|
||||
|
||||
- Utilizzare TypeScript.
|
||||
- Preferire funzioni piccole.
|
||||
- Evitare duplicazione di codice.
|
||||
- Utilizzare componenti React riutilizzabili.
|
||||
- Commentare solamente il codice realmente complesso.
|
||||
- Preferire nomi descrittivi.
|
||||
- Non introdurre librerie senza reale necessità.
|
||||
- Mantenere la struttura esistente del progetto.
|
||||
@@ -0,0 +1,22 @@
|
||||
# CrAPP Context
|
||||
|
||||
CrAPP è una Progressive Web App dedicata alla gestione di una squadra di pallavolo amatoriale.
|
||||
|
||||
L'obiettivo principale NON è solamente registrare dati.
|
||||
|
||||
L'obiettivo è ridurre il lavoro amministrativo degli amministratori e aumentare il coinvolgimento dei giocatori attraverso gamification, statistiche e strumenti intelligenti.
|
||||
|
||||
Quando implementi nuove funzionalità:
|
||||
|
||||
- privilegia semplicità
|
||||
- mantieni la coerenza dell'interfaccia
|
||||
- evita duplicazioni
|
||||
- leggi sempre la documentazione presente in `docs/`
|
||||
|
||||
Prima di scrivere codice consulta:
|
||||
|
||||
- README
|
||||
- ROADMAP
|
||||
- DATABASE
|
||||
- ARCHITECTURE
|
||||
- il modulo interessato in `docs/modules`
|
||||
@@ -0,0 +1,11 @@
|
||||
# Development Workflow
|
||||
|
||||
Ogni nuova funzionalità segue questo flusso.
|
||||
|
||||
1. Discussione funzionale.
|
||||
2. Documento in `docs/modules`.
|
||||
3. Progettazione database.
|
||||
4. Implementazione su branch `develop`.
|
||||
5. Test.
|
||||
6. Merge su `main`.
|
||||
7. Deploy automatico tramite Vercel.
|
||||
@@ -0,0 +1,29 @@
|
||||
# Project Rules
|
||||
|
||||
Queste regole devono essere rispettate per qualsiasi modifica al progetto.
|
||||
|
||||
## Regole generali
|
||||
|
||||
- Non modificare il branch `main` direttamente.
|
||||
- Tutte le nuove funzionalità vengono sviluppate su `develop`.
|
||||
- Prima di implementare una funzionalità leggere sempre la documentazione presente in `docs/`.
|
||||
- Non creare codice duplicato.
|
||||
- Riutilizzare sempre componenti già esistenti quando possibile.
|
||||
- Mantenere uno stile coerente con il progetto.
|
||||
|
||||
## Database
|
||||
|
||||
- Non modificare il database senza creare una nuova migration Supabase.
|
||||
- Non eliminare tabelle esistenti senza esplicita richiesta.
|
||||
- Preferire nuove tabelle rispetto all'aggiunta di molte colonne quando il modulo è indipendente.
|
||||
|
||||
## Componenti
|
||||
|
||||
- Preferire componenti piccoli e riutilizzabili.
|
||||
- Evitare componenti con responsabilità multiple.
|
||||
|
||||
## Documentazione
|
||||
|
||||
Ogni nuova funzionalità deve essere documentata prima dell'implementazione.
|
||||
|
||||
La documentazione tecnica si trova nella cartella `docs/`.
|
||||
Reference in New Issue
Block a user