Руководства и рабочие процессы

Выберите гида

• Быстрый старт: установите зависимости, запустите рабочий стол и найдите его базу данных.
• Установить: загрузите опубликованную сборку рабочего стола, проверьте ее контрольную сумму и отличите ее от исходного кода.
• Счета: редактируйте профиль, пароль, ключи API и идентификатор git в локальной студии.
• Местное развитие: запустите предварительный просмотр в браузере или настоящую сайдкар, настройте процессы и выполните диагностику запуска.
• Содействие коду: найдите модули, измените общие контракты и выберите проверки.
• Пакеты: ориентироваться в обязанностях рабочего пространства и общественных точках входа.

Рабочий стол, сайдкар, сопутствующий сайт и сайт документации имеют разные команды запуска и модели сохранения. Выберите среду выполнения, которая реализует поведение, которое вы меняете. Фикстура браузера полезна для работы с экраном; для изменения базы данных, потоковой передачи и авторизации требуется реальный сервер.

Понимание времени выполнения

Базовый пакет реализует геометрию, траектории инструмента, штифты и проверку. Пакет API определяет общие схемы, конечные точки и созданные клиенты. Дополнительный модуль объединяет эти контракты с репозиториями, SQLite, искусственным интеллектом, плагинами, контролем версий и службами рабочих процессов. Рабочий стол предоставляет эти услуги через локальное соединение API и собственную оболочку.

Компаньон iOS подключается через отдельный закрепленный шлюз HTTPS. Веб-пакет запускает сайт документации Astro и локальную интеграцию Studio. Это отдельные клиенты, и не следует предполагать, что они имеют общий путь к базе данных или контекст безопасности.

Общие команды

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

desktop:dev строит настоящую сайдкар и осуществляет миграцию перед открытием Tauri. Рабочий стол dev скрипт запускает Vite на порту 1420; без дополнительного URL-адреса он использует API предварительного просмотра в памяти. Интернет start скрипт запускает только Astro; его dev скрипт также запускает локальный API Studio.

Создание миграции предназначено для изменений схемы, а не является обязательным условием установки. Уровень базы данных создает новую базу данных и применяет доступные миграции при открытии. Прежде чем выбирать путь к базе данных CLI, ознакомьтесь с кратким руководством.

Корневые скрипты определены в репозитории package.json: typecheck, test, build, build:sidecar, build:desktop, desktop:dev, generate, generate:check, db:generate, и db:migrate.

Начните с конкретного потока

Для настольной разработки откройте проект, создайте или загрузите чертеж и проверьте поток CAD/CAM, который вы хотите изменить. Следуйте адаптеру маршрута на экран функций и найдите вызов API и обработчик. Для работы сервера используйте схему, обработчик, сервис и цепочку репозиториев, чтобы определить, где происходят проверка, владение и сохранение.

Для совместной работы установите собственную сборку iOS, включите шлюз рабочего стола и выполните сопряжение с помощью его QR-кода. Для работы с документацией запустите Astro, откройте измененный маршрут и запустите веб-сборку, чтобы выявить ошибки шаблона и предварительной отрисовки.

Соблюдайте четкие границы

Храните учетные данные вне источника, примеров, журналов и снимков экрана браузера. Используйте заполнители в документации и предоставьте конфигурацию среды выполнения с помощью поддерживаемых параметров процесса или приложения. Синхронизируйте сгенерированные клиенты с их контрактом и генерируйте миграции SQL из схемы, а не редактируйте сгенерированные файлы миграции.

Используйте отдельный одноразовый каталог данных для интеграционных тестов и локальных экспериментов. Средство предварительного просмотра, база данных миграции CLI, база данных упакованных приложений и сопутствующий шлюз имеют разные цели; выбор одного должен быть явным.

Найдите правильный рабочий процесс

Используйте руководство по последовательности действий и связанные справочные страницы для получения подробной информации о полях и поведении. Сохраняйте выбор среды выполнения явным на протяжении всего рабочего процесса: переход от устройства браузера к встроенному дополнительному интерфейсу меняет постоянство, учетные данные, собственные возможности и поведение при ошибках.

Знайте, что устанавливает проверка

Разные проверки отвечают на разные вопросы. Компилятор TypeScript может доказать, что клиентский вызов соответствует сгенерированной подписи. Тест обработчика может подтвердить ожидаемый ответ на предоставленных уровнях. Запуск собственного симулятора может выполнять закрепление сертификата и запуск приложения. Ни один из них независимо не доказывает, что подписанный установщик работает на каждом поддерживаемом устройстве или что траектория инструмента безопасна для конкретной машины.

1. Запишите точную среду выполнения и каталог данных, использованный для проверки.
2. Выполните операцию через границу, которую будет использовать пользователь.
3. Проверьте полученное сохраненное состояние или экспортированный артефакт, а не только тост об успехе.
4. Отработайте путь отказа или отмены, на который повлияло изменение.
5. Сообщите, что все внешние службы, подписи, собственные устройства или графические покрытия все еще отсутствуют.

Для детерминированной работы по интеграции используйте изолированные каталоги SQLite и скриптовые/автономные средства искусственного интеллекта. Для поведения, зависящего от поставщика, отдельно проверьте настроенного поставщика с соответствующими учетными данными. Примеры запросов в этих руководствах описывают поддерживаемые формы; временные метки, идентификаторы, порты и учетные данные меняются в зависимости от запуска.

Практические руководства

В этих руководствах описаны все операции с приложением и его API. Каждый из них включает необходимые входные данные, соответствующие изменения состояния и случаи сбоев, подлежащие проверке. Используйте ссылки на подсистемы для базовых моделей и страницы ресурсов API для точных контрактов полей и ответов.

Проектирование и производство

Клиенты и расширения

Операции и восстановление

Впервые знакомы с опубликованной сборкой? Начать с Установить. Впервые на кассе? Начните с Быстрый старт. Новое в его поведении HTTP? Используйте пошаговое руководство с записанными ответами, затем выберите типизированного клиента или ресурс в полный справочник по API.

Выполните полную задачу

Создать сохраненный дизайн

Создайте проект и сохраните возвращенный идентификатор. Создайте его чертеж или компонент с помощью соответствующей коллекции на уровне проекта. Отредактируйте геометрию в рабочем пространстве САПР, сохраните фактическое действие элемента этого ресурса и повторно откройте сохраненный ресурс, чтобы убедиться, что предполагаемый документ сохранился. Текущий выбор редактора и история команд не заменяют сохраненный рисунок.

Когда два клиента редактируют одни и те же данные, следуйте текущей семантике обновления конечной точки, а не предполагайте, что каждый ресурс имеет защиту от сравнения и замены. Прочтите руководство по жизненному циклу проекта для различий между чертежами и компонентами, сопоставлений ресурсов, проверок доступа и ограничений восстановления.

Получить производственный результат

Зафиксируйте геометрию, размещение, материал, станок, инструменты и порядок операций. Запустите генерацию с этими явными входными данными. Изучите проблемы результата и применимые доказательства; убедитесь, что программа и ЧПУ соответствуют предполагаемому снимку. Сохранение является отдельной операцией и должно сохранять переносимый документ, соответствующий точному количеству сохраняемых байтов.

Измененная фреза, заготовка, модель или рабочий каркас меняют оцениваемую работу. Повторное использование более раннего артефакта после редактирования NC не переносит его свидетельства в новый текст. родное руководство по производству объясняет подготовку, генерацию, утверждения, проверку устойчивости и разницу между одной интегрированной опубликованной программой и разделами объединенных операций.

Интегрируйте помощника

Настройте провайдера на рабочем столе и проверьте его статус перед началом разговора. Сохраняйте идентичность проекта и сеанса, постепенно обрабатывайте события и реализуйте разрешения и ответы на вопросы с помощью разрешенных элементов управления сеансом. При отключении восстановите текущее состояние перед повторной отправкой запроса, который мог отредактировать проект.

The руководство по потоковому вещанию покрывает восстановление, отмену и последующий прием. руководство для клиентов объясняет, почему значения результатов Promise, выброшенные тела HTTP, ошибки эффектов и завершение потока не могут обрабатываться как один универсальный конверт.

Запишите и просмотрите изменение

Сохраните рабочий ресурс, проверьте состояние проекта и зафиксируйте предполагаемое состояние в намеченной ветке. Просмотрите структурные различия и откройте локальный запрос на включение, если изменение следует предложить, а не принять напрямую. Устраняйте вердикты и конфликты блокирующих проверок перед слиянием.

Версируйте определения рабочего процесса вместе с проектом, затем проверяйте выбранную фиксацию каждого запуска и отдельные результаты проверки. Успешный прогон, в котором пропущены проверки обработки, не является доказательством обработки. Прочтите руководство по веткам и рабочему процессу перед автоматизацией этапа записи или настройкой удаленного зеркала.

Работа со вторым клиентом

Намеренно включите сопутствующий шлюз, создайте пару устройств с индивидуальным именем и подключите собственную сборку, включающую закрепление сертификата. Сохраните полный адрес рабочего стола, отпечаток пальца и токен устройства в качестве парного соединения. Прежде чем предполагать, что телефон доступен только для чтения или не имеет ограничений, прочтите текущую политику маршрутизации.

Когда доступ закончится, отзовите устройство с рабочего стола; удаление соединения только на телефоне не отменяет токен на стороне сервера. руководство по сопряжению разделяет диагностику сети, доступность собственного транспорта, удостоверение сертификата и отзыв токена.

Руководства по задачам и времени

Через 3Д