Guias e fluxos de trabalho

Escolha um guia

• Início rápido: instale dependências, inicie a área de trabalho e localize seu banco de dados.
• Instalar: baixe uma versão de desktop publicada, verifique sua soma de verificação e diferencie-a de uma verificação de origem.
• Contas: edite perfil, senha, chaves de API e identidade git no Studio local.
• Desenvolvimento local: execute uma visualização do navegador ou um sidecar real, configure processos e diagnostique a inicialização.
• Código de contribuição: localize módulos, altere contratos compartilhados e selecione cheques.
• Pacotes: navegue pelas responsabilidades do espaço de trabalho e pelos pontos de entrada públicos.

O desktop, o sidecar, o complementar e o site de documentação têm diferentes comandos de inicialização e modelos de persistência. Escolha o tempo de execução que exercita o comportamento que você está alterando. Um acessório de navegador é útil para trabalho na tela; alterações de banco de dados, streaming e autorização precisam do servidor real.

Entenda o tempo de execução

O pacote principal implementa geometria, percursos da ferramenta de ferramenta, postes e verificação. O pacote API define esquemas compartilhados, endpoints e clientes gerados. O sidecar combina esses contratos com repositórios, SQLite, IA, plugins, controle de versão e serviços de fluxo de trabalho. A área de trabalho renderiza esses serviços por meio de uma conexão API local e shell nativo.

O complemento iOS se conecta por meio de um gateway HTTPS fixado separado. O pacote web executa o site de documentação do Astro e a integração local do Studio. Esses são clientes separados e não deve ser assumido que compartilhem um caminho de banco de dados ou contexto de segurança.

Comandos comuns

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

desktop:dev constrói o sidecar real e organiza as migrações antes de abrir o Tauri. A área de trabalho dev o script inicia o Vite na porta 1420; sem um URL secundário, ele usa uma API de visualização na memória. A teia start o script inicia apenas o Astro; isso é dev script também inicia a API local do Studio.

A geração de migração é para alterações de esquema, não um pré-requisito de instalação. A camada de banco de dados cria um novo banco de dados e aplica as migrações disponíveis quando abertas. Consulte o início rápido antes de escolher um caminho de banco de dados CLI.

Os scripts raiz são definidos no repositório package.json: typecheck, test, build, build:sidecar, build:desktop, desktop:dev, generate, generate:check, db:generate, e db:migrate.

Comece com um fluxo concreto

Para desenvolvimento em desktop, abra um projeto, crie ou carregue um desenho e inspecione o fluxo CAD/CAM que você pretende modificar. Siga seu adaptador de rota até a tela de recursos e localize a chamada e o manipulador da API. Para o trabalho do servidor, use o esquema, o manipulador, o serviço e a cadeia de repositórios para identificar onde ocorrem a validação, a propriedade e a persistência.

Para trabalho complementar, instale uma versão nativa do iOS, habilite o gateway de desktop e emparelhe por meio de seu código QR. Para trabalho de documentação, inicie o Astro, abra a rota alterada e execute a construção da web para detectar erros de modelo e pré-renderização.

Mantenha limites claros

Mantenha as credenciais fora da fonte, exemplos, registros e capturas de tela do navegador. Use espaços reservados na documentação e forneça configuração de tempo de execução por meio do processo compatível ou das configurações do aplicativo. Mantenha os clientes gerados sincronizados com seus contratos e gere migrações SQL a partir do esquema em vez de editar os arquivos de migração gerados.

Use um diretório de dados descartáveis separado para testes de integração e experimentos locais. Um dispositivo de visualização, um banco de dados de migração CLI, um banco de dados de aplicativos empacotados e um gateway complementar têm finalidades distintas; a seleção de um deve ser explícita.

Encontre o fluxo de trabalho certo

Use um guia para uma sequência de ações e as páginas de referência vinculadas para detalhes de campo e comportamento. Mantenha a escolha do tempo de execução explícita em todo o fluxo de trabalho: mudar de um dispositivo de navegador para um sidecar nativo altera a persistência, as credenciais, os recursos nativos e o comportamento de erro.

Saiba o que uma verificação estabelece

Verificações diferentes respondem a perguntas diferentes. Um compilador TypeScript pode provar que uma chamada de cliente corresponde à assinatura gerada. Um teste de manipulador pode provar a resposta esperada nas camadas fornecidas. Uma execução de simulador nativo pode exercer a fixação de certificados e a inicialização do aplicativo. Nada disso prova de forma independente que um instalador assinado é executado em todos os dispositivos suportados ou que um percurso é seguro para uma máquina específica.

1. Registre o tempo de execução exato e o diretório de dados usados para a verificação.
2. Execute a operação através do limite que o usuário usará.
3. Inspecione o estado persistente resultante ou o artefato exportado, não apenas um brinde de sucesso.
4. Exercite o caminho de falha ou cancelamento afetado pela mudança.
5. Relate qualquer serviço externo, assinatura, dispositivo nativo ou cobertura gráfica que ainda esteja faltando.

Para trabalho de integração determinística, use diretórios SQLite isolados e acessórios de IA com script/offline. Para comportamento específico do provedor, exercite separadamente o provedor configurado com credenciais apropriadas. Os exemplos de solicitações nestes guias descrevem formas suportadas; carimbos de data/hora, identificadores, portas e credenciais variam de acordo com a execução.

Guias práticos

Esses guias acompanham as operações completas por meio do aplicativo e de sua API. Cada um inclui as entradas necessárias, as mudanças de estado relevantes e os casos de falha a serem inspecionados. Use as referências do subsistema para modelos subjacentes e as páginas de recursos da API para contratos exatos de campo e resposta.

Projeto e fabricação

Clientes e extensões

Operações e recuperação

Novo em uma compilação publicada? Começar em Instalar. Novo no checkout? Comece com Início rápido. Novo em seu comportamento HTTP? Use o passo a passo com respostas capturadase escolha um cliente digitado ou um recurso no campo referência completa da API.

Trabalhe em uma tarefa completa

Crie um design salvo

Crie um projeto e retenha o identificador retornado. Crie seu desenho ou componente por meio da coleção apropriada no escopo do projeto. Edite a geometria no espaço de trabalho CAD, salve por meio da ação real do recurso desse recurso e reabra o recurso salvo para estabelecer que o documento pretendido foi persistido. A seleção atual e o histórico de comandos do editor não substituem o desenho armazenado.

Quando dois clientes editam os mesmos dados, siga a semântica de atualização atual do ponto final em vez de assumir que cada recurso tem proteção de comparação e troca. Leia o guia do ciclo de vida do projeto para diferenças de desenhos/componentes, associações de recursos, verificações de acesso e limites de restauração.

Produzir um resultado de fabricação

Capture a geometria, posicionamento, estoque, material, máquina, ferramentas e ordem de operação. Execute a geração com essas entradas explícitas. Inspecione os problemas do resultado e as evidências aplicáveis; verifique se o programa e o NC correspondem ao instantâneo pretendido. Salvar é uma operação separada e deve reter um documento portátil consistente com os bytes exatos que estão sendo salvos.

Uma cortadora, material, modelo ou estrutura de trabalho alterado altera o trabalho que está sendo avaliado. A reutilização de um artefato anterior após a edição do NC não transfere suas evidências para o novo texto. O guia de fabricação nativa explica preparação, geração, declarações, validação de persistência e a diferença entre um programa postado integrado e seções de operação concatenadas.

Integrar um assistente

Configure um provedor no desktop e verifique seu status antes de iniciar uma conversa. Preserve a identidade do projeto e da sessão, consuma eventos de forma incremental e implemente permissões e respostas a perguntas por meio dos controles de sessão admitidos. Ao desconectar, recupere o estado atual antes de reenviar uma solicitação que possa ter editado o projeto.

O guia de streaming cobre recuperação, cancelamento e admissão de acompanhamento. O guia do cliente explica por que os valores dos resultados da promessa, os corpos HTTP lançados, os erros de efeito e a conclusão do fluxo não podem ser tratados como um envelope universal.

Registrar e revisar uma alteração

Salve o recurso de trabalho, inspecione o status do projeto e confirme o estado pretendido na ramificação pretendida. Revise a diferença estrutural e abra uma solicitação pull local quando a mudança precisar ser proposta em vez de adotada diretamente. Resolva veredictos e conflitos de revisão de bloqueio antes de mesclar.

Versão das definições de fluxo de trabalho com o projeto e, em seguida, inspecione a confirmação selecionada de cada execução e as saídas de verificação individuais. Uma execução bem-sucedida que ignorou as verificações de usinagem não fornece evidências de usinagem. Leia o ramificações e guia de fluxo de trabalho antes de automatizar uma etapa de escrita ou configurar um espelho remoto.

Operar um segundo cliente

Habilite intencionalmente o gateway complementar, crie um emparelhamento de dispositivos nomeado individualmente e conecte uma compilação nativa que inclua fixação de certificado. Mantenha o endereço completo da área de trabalho, a impressão digital e o token do dispositivo como conexão emparelhada. Leia a política de rota atual antes de assumir que um telefone é somente leitura ou irrestrito.

Quando o acesso terminar, revogue o dispositivo do desktop; remover apenas a conexão do telefone não revoga o token do lado do servidor. O guia de emparelhamento separa diagnóstico de rede, disponibilidade de transporte nativo, identidade de certificado e revogação de token.

Guias por tarefa e tempo

Em 3D