Начните с определённой архитектуры, а не с пустого репозитория.

Архитектура вкратце

Четыре этапа с одним направлением зависимостей. Два средних — основа, первый и последний — ваши.

1. Stage 1

   Данные сайта, контент и ресурсы

   Идентичность, навигация, языки, контент Markdown и графика — вход внедренца, проверяемый до того, как что-либо его прочитает.

2. Stage 2

   Производная среда Foundation

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

3. Stage 3

   Представление, маршрутизация и точки интеграции

   Маршруты, композиция макета, метаданные и фабрики адаптеров, связывающие из конфигурации бронирование, обращения, карты и аналитику.

4. Stage 4

   Развёртывание

   Сборка с приоритетом статической генерации, развёртываемая из вашего репозитория в ваш аккаунт хостинга.

Направление зависимостей утверждается тестами, а не предполагается: ядро не может импортировать React, Next.js или внешний слой, а слой приложения не может зайти в конкретный адаптер.

ARCHITECTURE.md в репозитории

Конфигурация или код

Эта граница — суть проекта. Большинство решений, специфичных для бизнеса, — это данные; настоящие расширения — код, и Foundation прямо говорит, что есть что.

Инженерный контракт

К чему проект обязуется и что отказывается утверждать.

• Строго проверяемая конфигурация

  Одна схема, отказ от неизвестных ключей, действенные ошибки и чтение конфигурации только через загрузчик.

• Гексагональные границы

  Чистое ядро, порты и сервисы приложения, адаптеры за фабриками и тонкие маршруты фреймворка.

• Принуждение зависимостей

  Архитектурные тесты обходят дерево исходников и падают на запрещённом импорте, поэтому схема не может отойти от кода.

• Композиция с приоритетом сервера

  React Server Components и статическая генерация по умолчанию, клиентская интерактивность ограничена нужными компонентами.

• Проверка в реальных браузерах

  Закоммиченная матрица headless-браузера проверяет ширины для компьютера, планшета и мобильного, клавиатуру и указатель, уменьшенное движение и тёмную схему и останавливает запуск при любом невыполненном утверждении.

• Шлюзы архитектуры и модульных тестов

  Тесты границ и модульные тесты идут вместе с проверкой ресурсов, типов, lint и производственной сборкой.

• Дисциплина утверждений о возможностях

  Документированные утверждения сверяются с собственным реестром проекта, поэтому утверждение не может превысить доказательства.

• Честная модель обновления

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

Где Foundation останавливается

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

Расширение идёт снаружи внутрь: новый провайдер — это адаптер, ветвь фабрики и элемент перечисления в схеме, а новый тип контента или язык — данные. Действительно новая возможность — работа платформы.

Поток внедрения

Восемь этапов. Детали на уровне команд — в репозитории; здесь показана форма работы.

1. 1

   Получить Foundation

   Клонируйте или форкните публичный репозиторий.

2. 2

   Установить и запустить

   Установите зависимости и запустите сайт локально.

3. 3

   Настроить

   Определите идентичность, языки, функции и выбор провайдеров.

4. 4

   Написать контент и ресурсы

   Опишите страницы и замените роли брендовых ресурсов.

5. 5

   Подключить провайдеров

   Направьте точки интеграции на реально используемые сервисы.

6. 6

   Проверить

   Запустите шлюз качества проекта локально.

7. 7

   Развернуть

   Соберите и разверните из своего репозитория и аккаунта.

8. 8

   Поддерживать и обновлять

   Принимайте улучшения сверху, не перезаписывая свои материалы.

Руководства в репозитории охватывают каждый этап, включая устранение неполадок.

Авторитетная документация

GitHub — канонический технический источник. Этот сайт резюмирует, репозиторий инструктирует.

• Repository

  Полный код, лицензия и заявление проекта о том, чем он является и чем не является.

• README.md

  Что это за проект, быстрый старт, структура репозитория и позиция по лицензии.

• ARCHITECTURE.md

  Архитектурный стиль, границы, направление зависимостей и шаблоны интеграции.

• CUSTOMIZING.md

  Руководство для последующего пользователя и полный справочник конфигурации.

• DEPLOYMENT.md

  Runbook выпуска и список проверок после развёртывания.

• BRAND_ASSETS.md

  Контракт замены брендовых ресурсов: каждая заменяемая визуальная роль.

• Руководства

  Процедуры внедрения, настройки, бренда, контента, обновления, валидации, развёртывания и устранения неполадок.

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