Συνεισφορά στο Bubllio CRM

Τι περιέχει αυτή η αποθήκηΑντιγραφή συνδέσμου ενότητας

Το Bubllio CRM είναι ένα Django REST API και ένα επίσημο React client σε ένα μονόρεπο:

repository
├── src/                  Django backend and domain logic
├── frontend/             React/TypeScript client
├── docs/                 architecture, API, development, and walkthrough docs
├── skills/               focused implementation checklists
├── .github/workflows/    repository CI
├── pyproject.toml        Python dependency intent
└── uv.lock               exact Python dependency resolution

Το backend είναι η πηγή της αλήθειας για την authentication, τη δέσμευση, τις άδειες, την επικύρωση, και την επιχειρηματική συμπεριφορά. Το frontend είναι ένας αντικαταστάσιμος πελάτης: θα πρέπει να κάνει το API εύκολο στη χρήση, αλλά δεν πρέπει ποτέ να γίνει ένα δεύτερο μέρος όπου η έγκριση ή οι κανόνες tenant isolation εφαρμόζονται.

Πριν από την αλλαγή του κώδικαΑντιγραφή συνδέσμου ενότητας

1. Διαβάστε αυτόν τον οδηγό και Διάρθρωση έργου.
2. Διαβάστε τη σελίδα αρχιτεκτονικής για τον τομέα που θα αλλάξετε:
   • Δεδομένα CRM: Κτήμα CRM
   • Authentication και ρόλοι: Επικύρωση και Ρόλοι
   • automations: Αυτοματισμοί
   • Ηλ. διεύθυνση: Ηλ. διεύθυνση αποστολής
3. Ελέγξτε αν υπάρχει εστιασμένη ροή εργασίας στο skills/.
4. Αναζήτηση της υπάρχουσας συμπεριφοράς πριν από την εισαγωγή μιας παράλληλης αφαίρεσης.

Τα αρχιτεκτονικά έγγραφα περιγράφουν την εφαρμοσμένη συμπεριφορά εκτός αν επισημάνουν ρητά ένα τμήμα όπως έχει προγραμματιστεί. Το Automation Roadmap δεν είναι σκόπιμα μια λίστα των διαθέσιμων APIs.

Τοπική εγκατάστασηΑντιγραφή συνδέσμου ενότητας

Από τη ρίζα αποθετηρίου:

uv sync
uv run python src/manage.py migrate
uv run python src/manage.py createsuperuser

Εκκίνηση του backend στο τερματικό ένα:

uv run python src/manage.py runserver 127.0.0.1:8000

Εκκίνηση του frontend στο τερματικό δύο:

cd frontend
npm ci
npm run dev

Άνοιγμα http://127.0.0.1:5173. Vite proxies /api/ σε Django, έτσι browser αιτήματα παραμένουν ίδια-προέλευση κατά την τοπική ανάπτυξη. Οι πλήρεις σημειώσεις ρύθμισης και αντιμετώπισης προβλημάτων βρίσκονται στο Getting Started.

Επιλογή όπου ανήκει ο κώδικαςΑντιγραφή συνδέσμου ενότητας

Χρησιμοποιήστε αυτόν τον πίνακα αποφάσεων πριν προσθέσετε μια συνάρτηση:

Μην μετακινήσετε τους κανόνες της επιχείρησης στο React επειδή ένα κουμπί πρέπει να είναι κρυμμένο. Ένα κρυφό κουμπί είναι μια βελτίωση χρηστικότητας; ο έλεγχος άδειας Django είναι το όριο ασφαλείας.

Κανονική αλλαγή backendΑντιγραφή συνδέσμου ενότητας

Για έναν νέο πόρο REST, χρησιμοποιήστε αυτή τη σειρά:

model → migration → admin registration → serializer and validation
  → permission/query scoping → view → app URL → tests
  → documentation and examples

Χρήση UUID για δημόσιους αναγνωριστικούς κωδικούς. Για τα δεδομένα που ανήκουν στον οργανισμό, επιλύστε τον οργανισμό από τον πιστοποιημένο χρήστη και URL, στη συνέχεια περάστε ότι επιλύθηκε οργάνωση σε ερωτήματα και αποθηκεύει. Ποτέ μην εμπιστεύεστε ένα εισερχόμενο πεδίο organization από τον πελάτη.

Κατά την αλλαγή ενός μοντέλου:

uv run python src/manage.py makemigrations
uv run python src/manage.py migrate
uv run python src/manage.py makemigrations --check --dry-run

Ποτέ μην επεξεργαστείτε μια ήδη εφαρμοσμένη migration. Δημιουργήστε μια νέα migration.

Κανονική αλλαγή frontendΑντιγραφή συνδέσμου ενότητας

Το frontend έχει τρία διακριτά είδη κατάστασης:

1. **Το Server state ** ανήκει στο TanStack Query. Παραδείγματα: οργανώσεις, εταιρείες, επαφές, κανόνες automation, και τρέχει ιστορία.
2. **Η κατάσταση επιβεβαίωσης ** ανήκει στο κατάστημα Zustand. Πρόσβαση και ανανέωση Τα σημεία είναι μόνο μνήμης· μια σελίδα επαναφόρτωση σκόπιμα απαιτεί και πάλι σύνδεση.
3. ** Τοπική κατάσταση UI ** ανήκει κοντά στο συστατικό. Παραδείγματα: ανοιχτός διάλογος κατάσταση, κείμενο αναζήτησης και επιλεγμένες τιμές φόρμας.

Χρησιμοποιήστε το περιτύλιγμα Axios στο frontend/src/services/api.ts μέσω της υπηρεσίας και του hook της λειτουργίας ιδιοκτησίας. Συμπεριλάβετε την ταυτότητα οργάνωσης σε κάθε οργανισμό URL και το query key. Μετά από μια επιτυχημένη μετάλλαξη, ακυρώστε το επηρεασμένο πλήκτρο TanStack Query.

Δοκιμή και επαλήθευσηΑντιγραφή συνδέσμου ενότητας

Εκτέλεση της μικρότερης σχετικής δοκιμής κατά την επανάληψη, στη συνέχεια, εκτελέστε τους πλήρεις ελέγχους πριν ανοίξετε μια αίτηση έλξης:

# Backend
uv run python src/manage.py check
uv run python src/manage.py makemigrations --check --dry-run
uv run python src/manage.py test bubllio_crm organizations access onboarding companies contacts automations

# Frontend
cd frontend
npm run lint
npm test
npm run build
npm run test:e2e

Οι δοκιμές browser κοροϊδεύουν την κίνηση API και δεν γράφουν στην τοπική βάση δεδομένων CRM. Οι δοκιμές backend χρησιμοποιούν μια απομονωμένη βάση δεδομένων δοκιμών. Εκτέλεση migrate ξεχωριστά όταν θέλετε να χρησιμοποιήσετε τη βάση δεδομένων SQLite ανάπτυξης.

Λίστα ελέγχου αίτησης έλξηςΑντιγραφή συνδέσμου ενότητας

Πριν ζητήσετε επανεξέταση, επιβεβαιώστε:

• Η αλλαγή έχει μια εστιασμένη δοκιμή ή ένα τεκμηριωμένο λόγο μια δοκιμή δεν είναι χρήσιμη.
• Διατηρούνται όρια για δημιουργία, λίστα, ενημέρωση και διαγραφή.
• Νέο μοντέλο αλλαγές έχουν μια νέα migration.
• Οι κωδικοί κατάστασης API και τα σχήματα σφαλμάτων ακολουθούν REST API Patterns.
• Ο κωδικός Frontend χρησιμοποιεί τις υπάρχουσες αφαιρέσεις Axios, Zustand, και TanStack.
• Η τεκμηρίωση λέει αν η συμπεριφορά υλοποιείται ή προγραμματίζεται.
• README, Postman παραδείγματα, και walkthroughs δεν περιγράφουν outdated behavior.
• Δεν αρχεία βάσεων δεδομένων, .env αρχεία, tokens, κωδικούς πρόσβασης, την έξοδο κατασκευής, ή Περιλαμβάνονται κατάλογοι εξάρτησης.
• git diff --check και οι πλήρεις εντολές επαλήθευσης περνούν.

Κοινά λάθηΑντιγραφή συνδέσμου ενότητας

“Προσέθεσα ένα πεδίο αλλά το API δεν το δείχνει”Αντιγραφή συνδέσμου ενότητας

Το μοντέλο και το serializer είναι ξεχωριστά. Προσθέστε το πεδίο στη σαφή λίστα serializer του fields και προσθέστε την επικύρωση αν είναι εγγράψιμο.

“Ο χρήστης μπορεί να δει το αντικείμενο άλλου οργανισμού”Αντιγραφή συνδέσμου ενότητας

Ελέγξτε τόσο τον αναλυτή οργάνωσης όσο και το queryset. Ένα UUID σε ένα URL δεν είναι authorization από μόνη της. Ο πιστοποιημένος χρήστης πρέπει να έχει ένα μέλος, και η επιλυμένη οργάνωση πρέπει να χρησιμοποιείται σε κάθε ερώτημα.

“Το frontend εξακολουθεί να εμφανίζει παλιά δεδομένα μετά τη δημιουργία μιας εγγραφής”Αντιγραφή συνδέσμου ενότητας

Ακυρώστε το αντίστοιχο πλήκτρο TanStack Query μετά την επιτυχία της μετάλλαξης. Να μην αναπαράγονται χειροκίνητα δεδομένα εξυπηρετητή σε Zustand ή σε κατάσταση συστατικού.

“Η σύνδεση λειτουργεί σε δοκιμές αλλά όχι μετά την αναζωογόνηση του browser”Αντιγραφή συνδέσμου ενότητας

Αυτό αναμένεται για τον τρέχοντα εκκινητή: τα σημεία είναι σκόπιμα μόνο μνήμης. Εάν χρειάζεται επιμονή, να τεκμηριώσετε πρώτα την απόφαση ασφάλειας· μην τοποθετείτε διακριτικά σημεία στην τοπική αποθήκη.

“Άλλαξα τον automation roadmap και η λειτουργία φάνηκε να λειτουργεί”Αντιγραφή συνδέσμου ενότητας

Τα διαγράμματα χάρτη πορείας είναι επεξηγηματικά. Ένα χαρακτηριστικό υποστηρίζεται μόνο όταν υπάρχει μια υλοποιημένη διαδρομή backend, δοκιμές, και τρέχουσα τεκμηρίωση που το περιγράφει.