Guide e flussi di lavoro

Scegli una guida

• Avvio rapido: installa le dipendenze, avvia il desktop e individua il suo database.
• Installare: scarica una build desktop pubblicata, controlla il suo checksum e distinguila dal checkout del codice sorgente.
• Conti: modifica profilo, password, chiavi API e identità git in Studio locale.
• Sviluppo locale: esegui un'anteprima del browser o un vero sidecar, configura i processi e diagnostica l'avvio.
• Codice contributo: individua i moduli, modifica i contratti condivisi e seleziona i controlli.
• Pacchetti: esplorare le responsabilità dello spazio di lavoro e i punti di ingresso pubblici.

Il desktop, il sidecar, il compagno e il sito di documentazione hanno comandi di avvio e modelli di persistenza diversi. Scegli il runtime che esercita il comportamento che stai modificando. Un dispositivo browser è utile per il lavoro sullo schermo; le modifiche al database, allo streaming e alle autorizzazioni richiedono il real server.

Comprendere il tempo di esecuzione

Il pacchetto principale implementa geometria, percorsi utensile, montanti e verifica. Il pacchetto API definisce schemi condivisi, endpoint e client generati. Il sidecar combina questi contratti con repository, SQLite, AI, plugin, controllo della versione e servizi di flusso di lavoro. Il desktop esegue il rendering di tali servizi tramite una connessione API locale e una shell nativa.

Il compagno iOS si connette tramite un gateway HTTPS aggiunto separato. Il pacchetto web esegue il sito di documentazione di Astro e l'integrazione di Studio locale. Si tratta di client separati e non si deve presumere che condividano un percorso di database o un contesto di sicurezza.

Comandi comuni

bun install
bun run desktop:dev
bun run --filter @cadcamfun/desktop dev
bun run --cwd packages/web start

desktop:dev costruisce il vero sidecar e mette in scena le migrazioni prima di aprire Tauri. La scrivania dev lo script avvia Vite sulla porta 1420; senza un URL sidecar utilizza un'API di anteprima in memoria. La rete start lo script avvia solo Astro; suo dev lo script avvia anche l'API di Studio locale.

La generazione della migrazione riguarda le modifiche dello schema, non un prerequisito di installazione. Il livello database crea un nuovo database e applica le migrazioni disponibili quando viene aperto. Consulta la guida rapida prima di scegliere un percorso del database CLI.

Gli script root sono definiti nel repository package.json: typecheck, test, build, build:sidecar, build:desktop, desktop:dev, generate, generate:check, db:generate, e db:migrate.

Inizia con un flusso concreto

Per lo sviluppo desktop, apri un progetto, crea o carica un disegno e controlla il flusso CAD/CAM che intendi modificare. Segui l'adattatore di percorso nella schermata delle funzionalità e individua la chiamata API e il gestore. Per il lavoro sul server, utilizzare lo schema, il gestore, il servizio e la catena di repository per identificare dove avvengono la convalida, la proprietà e la persistenza.

Per il lavoro complementare, installa una build iOS nativa, abilita il gateway desktop e associalo tramite il relativo codice QR. Per il lavoro di documentazione, avvia Astro, apri il percorso modificato ed esegui la build web per individuare gli errori di modello e prerendering.

Mantieni confini chiari

Mantieni le credenziali fuori dal codice sorgente, dagli esempi, dai log e dagli screenshot del browser. Utilizza i segnaposto nella documentazione e fornisci la configurazione di runtime tramite il processo supportato o le impostazioni dell'applicazione. Mantieni i client generati sincronizzati con il loro contratto e genera migrazioni SQL dallo schema anziché modificare i file di migrazione generati.

Utilizzare una directory di dati usa e getta separata per test di integrazione ed esperimenti locali. Un dispositivo di anteprima, un database di migrazione della CLI, un database delle applicazioni in pacchetto e un gateway complementare hanno scopi distinti; selezionarne uno dovrebbe essere esplicito.

Trova il flusso di lavoro giusto

Utilizza una guida per una sequenza di azioni e le pagine di riferimento collegate per i dettagli sul campo e sul comportamento. Mantieni esplicita la scelta del runtime durante tutto il flusso di lavoro: il passaggio da un dispositivo browser a un sidecar nativo modifica la persistenza, le credenziali, le funzionalità native e il comportamento degli errori.

Sapere cosa stabilisce un assegno

Controlli diversi rispondono a domande diverse. Un compilatore TypeScript può dimostrare che una chiamata client corrisponde alla firma generata. Un test del gestore può dimostrare la risposta prevista nei livelli forniti. L'esecuzione di un simulatore nativo può esercitare il blocco dei certificati e l'avvio dell'app. Nessuno di questi dimostra in modo indipendente che un programma di installazione firmato venga eseguito su ogni dispositivo supportato o che un percorso utensile sia sicuro per una macchina specifica.

1. Registrare l'esatto runtime e la directory dei dati utilizzati per il controllo.
2. Eseguire l'operazione attraverso il confine che verrà utilizzato dall'utente.
3. Ispeziona lo stato persistente risultante o l'artefatto esportato, non solo un brindisi di successo.
4. Esercitare il percorso di fallimento o di cancellazione interessato dalla modifica.
5. Segnala eventuali servizi esterni, firme, dispositivi nativi o copertura grafica ancora mancanti.

Per il lavoro di integrazione deterministica, utilizza directory SQLite isolate e dispositivi AI con script/offline. Per il comportamento specifico del provider, esercitare separatamente il provider configurato con le credenziali appropriate. Le richieste di esempio in queste guide descrivono le forme supportate; timestamp, identificatori, porte e credenziali variano in base all'esecuzione.

Guide pratiche

Queste guide seguono le operazioni complete attraverso l'applicazione e la sua API. Ciascuno include gli input richiesti, i cambiamenti di stato rilevanti e i casi di errore da ispezionare. Utilizza i riferimenti al sottosistema per i modelli sottostanti e le pagine delle risorse API per i contratti di campo e risposta esatti.

Progettazione e produzione

Client ed estensioni

Operazioni e recupero

Nuovo in una build pubblicata? Inizia alle Installare. Nuovo alla cassa? Inizia con Avvio rapido. Nuovo nel suo comportamento HTTP? Usa il procedura dettagliata con le risposte acquisite, quindi scegli un client digitato o una risorsa nel file riferimento API completo.

Completa un'attività completa

Crea un disegno salvato

Crea un progetto e conserva l'identificatore restituito. Crea il relativo disegno o componente tramite la raccolta con ambito di progetto appropriata. Modificare la geometria nell'area di lavoro CAD, salvare tramite l'azione della funzione effettiva della risorsa e riaprire la risorsa salvata per stabilire che il documento previsto è stato mantenuto. La selezione corrente dell'editor e la cronologia dei comandi non sostituiscono il disegno memorizzato.

Quando due client modificano gli stessi dati, segui la semantica di aggiornamento corrente dell'endpoint anziché presupporre che ogni risorsa disponga di protezione di confronto e scambio. Leggi il guida al ciclo di vita del progetto per differenze tra disegni/componenti, associazioni di risorse, controlli di accesso e limiti di ripristino.

Produrre un risultato di produzione

Cattura la geometria, il posizionamento, il grezzo, il materiale, la macchina, gli strumenti e l'ordine delle operazioni. Esegui la generazione con quegli input espliciti. Ispezionare i problemi del risultato e le prove applicabili; verificare che il programma e l'NC corrispondano allo snapshot previsto. Il salvataggio è un'operazione separata e deve conservare un documento portatile coerente con gli esatti byte da salvare.

Una taglierina, un grezzo, un modello o un quadro di lavoro modificato modifica il lavoro in fase di valutazione. Riutilizzare un artefatto precedente dopo aver modificato NC non ne trasferisce le prove nel nuovo testo. IL guida alla produzione nativa spiega la preparazione, la generazione, le richieste, la convalida della persistenza e la differenza tra un programma pubblicato integrato e sezioni operative concatenate.

Integra un assistente

Configura un provider sul desktop e verificane lo stato prima di iniziare una conversazione. Preserva l'identità del progetto e della sessione, utilizza gli eventi in modo incrementale e implementa le autorizzazioni e le risposte alle domande tramite i controlli di sessione ammessi. Alla disconnessione, ripristina lo stato corrente prima di inviare nuovamente una richiesta che potrebbe aver modificato il progetto.

Il guida in streaming copre il recupero, la cancellazione e il ricovero successivo. IL guida del cliente spiega perché i valori dei risultati Promise, i corpi HTTP generati, gli errori degli effetti e il completamento del flusso non possono essere gestiti come un unico involucro universale.

Registrare e rivedere una modifica

Salva la risorsa lavorativa, controlla lo stato del progetto e conferma lo stato previsto sul ramo previsto. Rivedi la differenza strutturale e apri una richiesta pull locale quando la modifica dovrebbe essere proposta anziché adottata direttamente. Risolvi i verdetti e i conflitti di revisione che bloccano prima della fusione.

Versionare le definizioni del flusso di lavoro con il progetto, quindi ispezionare il commit selezionato di ciascuna esecuzione e gli output dei controlli individuali. Un'esecuzione riuscita che ha saltato i controlli di lavorazione non fornisce prove di lavorazione. Leggi il filiali e guida al flusso di lavoro prima di automatizzare una fase di scrittura o configurare un mirror remoto.

Gestire un secondo client

Abilita intenzionalmente il gateway complementare, crea un abbinamento di dispositivi con nome individuale e connetti una build nativa che include il blocco del certificato. Conserva l'indirizzo completo del desktop, l'impronta digitale e il token del dispositivo come connessione associata. Leggi l'attuale policy sul percorso prima di dare per scontato che un telefono sia di sola lettura o senza restrizioni.

Quando l'accesso dovesse terminare, revocare il dispositivo dal desktop; la rimozione della sola connessione sul telefono non revoca il token lato server. IL guida all'abbinamento separa la diagnosi di rete, la disponibilità del trasporto nativo, l'identità del certificato e la revoca del token.

Guide per attività e ora

Nel 3D