Guides et flux de travail

Choisissez un guide

• Démarrage rapide: installez les dépendances, démarrez le bureau et localisez sa base de données.
• Installer: téléchargez une version de bureau publiée, vérifiez sa somme de contrôle et distinguez-la d'une extraction de source.
• Comptes: modifiez le profil, le mot de passe, les clés API et l'identité git dans le Studio local.
• Développement local: exécutez un aperçu du navigateur ou un véritable sidecar, configurez les processus et diagnostiquez le démarrage.
• Code contributeur: localisez les modules, modifiez les contrats partagés et sélectionnez les chèques.
• Forfaits: naviguer dans les responsabilités de l’espace de travail et les points d’entrée publics.

Le site de bureau, le sidecar, le compagnon et le site de documentation ont des commandes de lancement et des modèles de persistance différents. Choisissez le moteur d'exécution qui exerce le comportement que vous modifiez. Un appareil de navigateur est utile pour le travail sur écran ; Les modifications de base de données, de streaming et d’autorisation nécessitent le vrai serveur.

Comprendre le temps d'exécution

Le package de base implémente la géométrie, les parcours d'outils, les poteaux et la vérification. Le package API définit les schémas partagés, les points de terminaison et les clients générés. Le sidecar combine ces contrats avec des référentiels, SQLite, l'IA, des plugins, un contrôle de version et des services de workflow. Le bureau fournit ces services via une connexion API locale et un shell natif.

Le compagnon iOS se connecte via une passerelle HTTPS épinglée distincte. Le package Web exécute le site de documentation Astro et l'intégration locale de Studio. Il s'agit de clients distincts et il ne faut pas supposer qu'ils partagent un chemin de base de données ou un contexte de sécurité.

Commandes courantes

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

desktop:dev construit le véritable sidecar et effectue les migrations avant d'ouvrir Tauri. Le bureau dev le script démarre Vite sur le port 1420 ; sans URL sidecar, il utilise une API de prévisualisation en mémoire. Le Web start le script démarre Astro uniquement ; c'est dev le script démarre également l'API Studio locale.

La génération de migration concerne les modifications de schéma et n'est pas une condition préalable à l'installation. La couche de base de données crée une nouvelle base de données et applique les migrations disponibles lors de son ouverture. Consultez le guide de démarrage rapide avant de choisir un chemin de base de données CLI.

Les scripts racine sont définis dans le référentiel package.json: typecheck, test, build, build:sidecar, build:desktop, desktop:dev, generate, generate:check, db:generate, et db:migrate.

Commencez par un flux concret

Pour le développement de bureau, ouvrez un projet, créez ou chargez un dessin et inspectez le flux CAO/FAO que vous souhaitez modifier. Suivez son adaptateur d'itinéraire dans l'écran des fonctionnalités et localisez l'appel API et le gestionnaire. Pour le travail sur le serveur, utilisez la chaîne de schéma, de gestionnaire, de service et de référentiel pour identifier où se produisent la validation, la propriété et la persistance.

Pour un travail complémentaire, installez une version iOS native, activez la passerelle de bureau et associez-la via son code QR. Pour le travail de documentation, démarrez Astro, ouvrez l'itinéraire modifié et exécutez la version Web pour détecter les erreurs de modèle et de pré-rendu.

Maintenir des limites claires

Conservez les informations d'identification hors des sources, des exemples, des journaux et des captures d'écran du navigateur. Utilisez des espaces réservés dans la documentation et fournissez la configuration d'exécution via les paramètres de processus ou d'application pris en charge. Gardez les clients générés synchronisés avec leur contrat et générez des migrations SQL à partir du schéma plutôt que de modifier les fichiers de migration générés.

Utilisez un répertoire de données jetable distinct pour les tests d'intégration et les expériences locales. Un appareil de préversion, une base de données de migration CLI, une base de données d'application packagée et une passerelle compagnon ont des objectifs distincts ; en sélectionner un doit être explicite.

Trouvez le bon flux de travail

Utilisez un guide pour une séquence d'actions et les pages de référence liées pour les détails des champs et des comportements. Gardez le choix d'exécution explicite tout au long du flux de travail : le passage d'un élément de navigateur à un sidecar natif modifie la persistance, les informations d'identification, les fonctionnalités natives et le comportement des erreurs.

Savoir ce qu'établit un chèque

Différents contrôles répondent à différentes questions. Un compilateur TypeScript peut prouver qu'un appel client correspond à sa signature générée. Un test de gestionnaire peut prouver la réponse attendue sous les couches fournies. Une exécution de simulateur natif peut effectuer l’épinglage de certificat et le démarrage d’applications. Aucun de ces éléments ne prouve de manière indépendante qu'un programme d'installation signé s'exécute sur chaque périphérique pris en charge ou qu'un parcours d'outil est sûr pour une machine spécifique.

1. Enregistrez le runtime exact et le répertoire de données utilisés pour la vérification.
2. Effectuez l'opération à travers la limite que l'utilisateur utilisera.
3. Inspectez l’état persistant ou l’artefact exporté qui en résulte, et pas seulement un toast de réussite.
4. Exercez le chemin d’échec ou d’annulation affecté par le changement.
5. Signalez tout service externe, signature, périphérique natif ou couverture graphique encore manquant.

Pour un travail d'intégration déterministe, utilisez des répertoires SQLite isolés et des appareils d'IA scriptés/hors ligne. Pour un comportement spécifique au fournisseur, exercez séparément le fournisseur configuré avec les informations d'identification appropriées. Des exemples de requêtes dans ces guides décrivent les formes prises en charge ; les horodatages, les identifiants, les ports et les informations d'identification varient selon l'exécution.

Guides pratiques

Ces guides suivent les opérations complètes à travers l'application et son API. Chacun comprend les entrées requises, les changements d’état pertinents et les cas de défaillance à inspecter. Utilisez les références de sous-système pour les modèles sous-jacents et les pages de ressources API pour les contrats de champ et de réponse exacts.

Conception et fabrication

Clients et extensions

Opérations et récupération

Vous découvrez une version publiée ? Commencez à Installer. Nouveau à la caisse ? Commencez par Démarrage rapide. Nouveau dans son comportement HTTP ? Utilisez le procédure pas à pas avec les réponses capturées, puis choisissez un client typé ou une ressource dans le référence API complète.

Accomplir une tâche complète

Créer un design enregistré

Créez un projet et conservez l'identifiant renvoyé. Créez son dessin ou son composant via la collection appropriée à l'échelle du projet. Modifiez la géométrie dans l'espace de travail CAO, enregistrez via l'action de fonctionnalité réelle de cette ressource et rouvrez la ressource enregistrée pour établir que le document souhaité a été conservé. La sélection actuelle et l'historique des commandes de l'éditeur ne remplacent pas le dessin stocké.

Lorsque deux clients modifient les mêmes données, suivez la sémantique de mise à jour actuelle du point de terminaison plutôt que de supposer que chaque ressource dispose d'une protection contre la comparaison et l'échange. Lire le guide du cycle de vie du projet pour les différences de dessin/composant, les associations de ressources, les contrôles d'accès et les limites de restauration.

Produire un résultat de fabrication

Capturez la géométrie, le placement, le stock, le matériau, la machine, les outils et l'ordre d'opération. Exécutez la génération avec ces entrées explicites. Inspecter les problèmes du résultat et les preuves applicables ; vérifiez que le programme et la CN correspondent à l'instantané prévu. L'enregistrement est une opération distincte et doit conserver un document portable cohérent avec les octets exacts enregistrés.

Une fraise, un brut, un modèle ou un cadre de travail modifié modifie le travail en cours d'évaluation. La réutilisation d'un artefact antérieur après l'édition de NC ne transfère pas ses preuves dans le nouveau texte. Le guide de fabrication natif explique la préparation, la génération, les réclamations, la validation de la persistance et la différence entre un programme publié intégré et les sections d'opération concaténées.

Intégrer un assistant

Configurez un fournisseur sur le bureau et vérifiez son statut avant de démarrer une conversation. Préservez l’identité du projet et de la session, consommez les événements de manière incrémentielle et implémentez les autorisations et les réponses aux questions via les contrôles de session admis. A la déconnexion, récupérez l'état actuel avant de renvoyer une requête ayant pu modifier le projet.

Le guide de diffusion en continu couvre le rétablissement, l’annulation et l’admission de suivi. Le guide client explique pourquoi les valeurs des résultats Promise, les corps HTTP renvoyés, les erreurs d'effet et l'achèvement du flux ne peuvent pas être traités comme une enveloppe universelle.

Enregistrer et examiner une modification

Enregistrez la ressource de travail, inspectez l'état du projet et validez l'état prévu sur la branche prévue. Examinez la différence structurelle et ouvrez une pull request locale lorsque le changement doit être proposé plutôt que directement adopté. Résolvez les verdicts de révision bloquants et les conflits avant la fusion.

Versionnez les définitions de flux de travail avec le projet, puis inspectez les sorties de validation et de vérification individuelles sélectionnées pour chaque exécution. Une exécution réussie qui a ignoré ses contrôles d'usinage ne fournit pas de preuve d'usinage. Lire le branches et guide de flux de travail avant d'automatiser une étape d'écriture ou de configurer un miroir distant.

Utiliser un deuxième client

Activez intentionnellement la passerelle compagnon, créez un couplage d'appareils nommé individuellement et connectez une version native qui inclut l'épinglage de certificat. Conservez l'adresse complète du bureau, l'empreinte digitale et le jeton de l'appareil en tant que connexion couplée. Lisez la politique d'itinéraire actuelle avant de supposer qu'un téléphone est en lecture seule ou sans restriction.

Lorsque l'accès doit prendre fin, retirez l'appareil du bureau ; la suppression de la connexion sur le téléphone à elle seule ne révoque pas le jeton côté serveur. Le guide d'appariement sépare le diagnostic du réseau, la disponibilité du transport natif, l'identité du certificat et la révocation du jeton.

Guides par tâche et par heure

En 3D