Guías y flujos de trabajo

Elige una guía

• Inicio rápido: instale dependencias, inicie el escritorio y ubique su base de datos.
• Instalar: descargue una compilación de escritorio publicada, verifique su suma de verificación y diferéndala de una extracción de origen.
• Cuentas: edite el perfil, la contraseña, las claves API y la identidad de git en Studio local.
• Desarrollo local: ejecute una vista previa del navegador o un sidecar real, configure procesos y diagnostique el inicio.
• Código contribuyente: localizar módulos, cambiar contratos compartidos y seleccionar comprobaciones.
• Paquetes: navegue por las responsabilidades del espacio de trabajo y los puntos de entrada públicos.

El sitio de escritorio, sidecar, complementario y de documentación tienen diferentes comandos de inicio y modelos de persistencia. Elija el tiempo de ejecución que ejercite el comportamiento que está cambiando. Un dispositivo de navegador es útil para trabajar con la pantalla; Los cambios en la base de datos, la transmisión y la autorización necesitan el servidor real.

Entender el tiempo de ejecución

El paquete principal implementa geometría, trayectorias de herramientas, publicaciones y verificación. El paquete API define esquemas compartidos, puntos finales y clientes generados. El sidecar combina esos contratos con repositorios, SQLite, IA, complementos, control de versiones y servicios de flujo de trabajo. El escritorio brinda esos servicios a través de una conexión API local y un shell nativo.

El complemento de iOS se conecta a través de una puerta de enlace HTTPS fijada por separado. El paquete web ejecuta el sitio de documentación de Astro y la integración local de Studio. Estos son clientes separados y no se debe asumir que comparten una ruta de base de datos o un contexto de seguridad.

Comandos comunes

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

desktop:dev construye el sidecar real y organiza las migraciones antes de abrir Tauri. el escritorio dev el script inicia Vite en el puerto 1420; sin una URL complementaria, utiliza una API de vista previa en memoria. la web start el guión inicia Astro únicamente; es dev el script también inicia la API de Studio local.

La generación de migración es para cambios de esquema, no un requisito previo de instalación. La capa de base de datos crea una nueva base de datos y aplica las migraciones disponibles cuando se abre. Consulte el inicio rápido antes de elegir una ruta de base de datos CLI.

Los scripts raíz se definen en el repositorio. package.json: typecheck, test, build, build:sidecar, build:desktop, desktop:dev, generate, generate:check, db:generate, y db:migrate.

Comience con un flujo concreto

Para el desarrollo de escritorio, abra un proyecto, cree o cargue un dibujo e inspeccione el flujo CAD/CAM que desea modificar. Siga su adaptador de ruta hasta la pantalla de funciones y localice la llamada API y el controlador. Para el trabajo del servidor, utilice el esquema, el controlador, el servicio y la cadena de repositorio para identificar dónde ocurren la validación, la propiedad y la persistencia.

Para trabajo complementario, instale una versión nativa de iOS, habilite la puerta de enlace de escritorio y empareje a través de su código QR. Para el trabajo de documentación, inicie Astro, abra la ruta modificada y ejecute la compilación web para detectar errores de plantilla y prerenderizado.

Mantener límites claros

Mantenga las credenciales fuera de la fuente, los ejemplos, los registros y las capturas de pantalla del navegador. Utilice marcadores de posición en la documentación y proporcione configuración de tiempo de ejecución a través del proceso admitido o la configuración de la aplicación. Mantenga los clientes generados sincronizados con su contrato y genere migraciones SQL desde el esquema en lugar de editar los archivos de migración generados.

Utilice un directorio de datos desechable independiente para pruebas de integración y experimentos locales. Un dispositivo de vista previa, una base de datos de migración CLI, una base de datos de aplicaciones empaquetadas y una puerta de enlace complementaria tienen propósitos distintos; La selección de uno debe ser explícita.

Encuentre el flujo de trabajo adecuado

Utilice una guía para una secuencia de acciones y las páginas de referencia vinculadas para obtener detalles de campo y comportamiento. Mantenga la elección del tiempo de ejecución explícita en todo el flujo de trabajo: cambiar de un dispositivo de navegador a un complemento nativo cambia la persistencia, las credenciales, las capacidades nativas y el comportamiento de error.

Sepa lo que establece un cheque

Diferentes controles responden a diferentes preguntas. Un compilador de TypeScript puede demostrar que la llamada de un cliente coincide con su firma generada. Una prueba de controlador puede demostrar la respuesta esperada en las capas proporcionadas. La ejecución de un simulador nativo puede ejercer la fijación de certificados y el inicio de aplicaciones. Ninguno de estos prueba de forma independiente que un instalador firmado se ejecute en todos los dispositivos compatibles o que una ruta de herramienta sea segura para una máquina específica.

1. Registre el tiempo de ejecución exacto y el directorio de datos utilizados para la verificación.
2. Realice la operación a través del límite que utilizará el usuario.
3. Inspeccione el estado persistente resultante o el artefacto exportado, no solo un brindis exitoso.
4. Ejercer la vía de falla o cancelación afectada por el cambio.
5. Informe cualquier servicio externo, firma, dispositivo nativo o cobertura de gráficos que aún falten.

Para un trabajo de integración determinista, utilice directorios SQLite aislados y accesorios de IA con script/fuera de línea. Para un comportamiento específico del proveedor, ejercite por separado el proveedor configurado con las credenciales adecuadas. Las solicitudes de ejemplo en estas guías describen formas admitidas; las marcas de tiempo, los identificadores, los puertos y las credenciales varían según la ejecución.

guías practicas

Estas guías siguen operaciones completas a través de la aplicación y su API. Cada uno incluye las entradas requeridas, los cambios de estado relevantes y los casos de falla a inspeccionar. Utilice las referencias del subsistema para los modelos subyacentes y las páginas de recursos de API para obtener campos exactos y contratos de respuesta.

Diseño y fabricación

Clientes y extensiones

Operaciones y recuperación

¿Nuevo en una compilación publicada? Empezar en Instalar. ¿Nuevo en la caja? Empezar con Inicio rápido. ¿Nuevo en su comportamiento HTTP? Utilice el tutorial con respuestas capturadas, luego elija un cliente escrito o un recurso en el referencia API completa.

Realizar una tarea completa

Crear un diseño guardado

Cree un proyecto y conserve el identificador devuelto. Cree su dibujo o componente a través de la colección apropiada con alcance de proyecto. Edite la geometría en el espacio de trabajo de CAD, guarde mediante la acción de característica real de ese recurso y vuelva a abrir el recurso guardado para establecer que el documento deseado persistió. La selección actual del editor y el historial de comandos no sustituyen al dibujo almacenado.

Cuando dos clientes editan los mismos datos, siga la semántica de actualización actual del punto final en lugar de asumir que cada recurso tiene protección de comparación e intercambio. Lea el guía del ciclo de vida del proyecto para diferencias de dibujo/componentes, asociaciones de recursos, comprobaciones de acceso y límites de restauración.

Producir un resultado de fabricación

Capture la geometría, ubicación, stock, material, máquina, herramientas y orden de operación. Ejecute la generación con esas entradas explícitas. Inspeccionar las cuestiones del resultado y la evidencia aplicable; verificar que el programa y NC correspondan a la instantánea deseada. Guardar es una operación independiente y debe conservar un documento portátil coherente con los bytes exactos que se guardan.

Un cortador, material, modelo o marco de trabajo modificado cambia el trabajo que se está evaluando. Reutilizar un artefacto anterior después de editar NC no transfiere su evidencia al nuevo texto. El guía de fabricación nativa explica la preparación, generación, reclamos, validación de persistencia y la diferencia entre un programa publicado integrado y secciones de operación concatenadas.

Integrar un asistente

Configure un proveedor en el escritorio y verifique su estado antes de iniciar una conversación. Preserve la identidad del proyecto y de la sesión, consuma eventos de forma incremental e implemente permisos y respuestas a preguntas a través de los controles de sesión admitidos. Al desconectarse, recupere el estado actual antes de reenviar una solicitud que pueda haber editado el proyecto.

El guía de transmisión cubre recuperación, cancelación e ingreso de seguimiento. El guía del cliente explica por qué los valores de resultados de Promise, los cuerpos HTTP generados, los errores de efectos y la finalización de la transmisión no se pueden manejar como un sobre universal.

Registrar y revisar un cambio

Guarde el recurso de trabajo, inspeccione el estado del proyecto y confirme el estado deseado en la rama deseada. Revise la diferencia estructural y abra una solicitud de extracción local cuando el cambio deba proponerse en lugar de adoptarse directamente. Resuelva los veredictos de revisión de bloqueo y los conflictos antes de fusionarse.

Versione las definiciones de flujo de trabajo con el proyecto y luego inspeccione las salidas de confirmación seleccionadas y comprobaciones individuales de cada ejecución. Una ejecución exitosa que se saltó las comprobaciones de mecanizado no proporciona evidencia de mecanizado. Lea el guía de ramas y flujo de trabajo antes de automatizar un paso de escritura o configurar un espejo remoto.

Operar un segundo cliente

Habilite la puerta de enlace complementaria intencionalmente, cree un emparejamiento de dispositivos con nombre individual y conecte una compilación nativa que incluya la fijación de certificados. Conserve la dirección completa del escritorio, la huella digital y el token del dispositivo como conexión emparejada. Lea la política de ruta actual antes de asumir que un teléfono es de solo lectura o no tiene restricciones.

Cuando finalice el acceso, revoque el dispositivo desde el escritorio; Quitar la conexión únicamente en el teléfono no revoca el token del lado del servidor. El guía de emparejamiento separa el diagnóstico de red, la disponibilidad de transporte nativo, la identidad del certificado y la revocación de token.

Guías por tarea y tiempo.

En 3D