DivKit

Этот документ на английском языке/This document in English

• README.md

Информация о ветках

• Ветки

Оглавление

• Оглавление
• Описание приложения
• Особенности использования и сборки
• Установка и сборка
• Скриншоты
• Варианты использования
• Структура проекта
• Правила использования и участие в разработке

Описание приложения

DivKit - это фреймворк с открытым исходным кодом Server-Driven UI (SDUI). Он позволяет выкатывать серверные обновления для разных версий приложений. DivKit - отличный выбор для начала использования серверно-управляемого пользовательского интерфейса в вашем проекте, потому что его можно легко интегрировать в качестве простого представления в любую часть вашего приложения. На начальном этапе вам не нужна интеграция с сервером. Вы можете включить весь JSON на стороне клиента, чтобы попробовать чтобы попробовать его в реальном приложении.

Особенности использования и сборки

Сборка проекта осуществляется с помощью Flutter SDK.
Плагины, которые используются:

• QR Code Scanner.
• File Selector.

Установка и сборка

Сборка приложения осущетсвляется на ОС Linux, лучше всего использовать Ubuntu не старее 22.04. Для сбоки приложения из под Windows необходимо установить WSL.
Перед сборкой приложения необходимо иметь следующие компоненты:

• Platform SDK
• Flutter SDK
• Aurora SDK для эмулятора Аврора ОС. Эти инструменты можно установить с помощью программ Aurora CLI или Aurora Toolbox.

Дальше с помощью команды:

flutter doctor --verbose

убедиться что Aurora toolchain доступен.
Команда для сборки приложения для Аврора ОС в Debug режиме для платформы ARM 64bit.

flutter build aurora --debug --target-platform=aurora-arm64

Разработку предпочтительнее вести в Visual Studio Code.

Скриншоты

Варианты использования

На домашней странице доступны три сценария работы: возможность загрузить json файл с устройства, или загрузить интерфейс с Divkit Playground, загрузить примеры, которые идут в поставке с приложением и режим тестирования.

• Главный режим Demo возможность самостоятельно создавать интерфейс для приложения. Можно загрузить готовый json файл с устройства. Есть возможность загрузить интерфейс с Playground. Для этого можно через кнопку Share можно взять ссылку или сканировать QR код. После этого на новой странице загружается интерфейс. Для подхватывания изменений есть кнопка Reload. Также есть возможность менять ориентацию интерфейса с Left to Right на Right to left кнопкой LTR. Можно сменить режим офрмления со светлого на темный(Light, Dark).
• В режиме Samples демонстрируются различные контролы, которые можно реализовать в итоговом интерфейсе.
• Режим Testing позволяет протестировать отдельные компоненты.

Структура проекта

Проект имеет структуру приложения на базе Dart и C++ для ОС Аврора.

• Каталог assets содержит json для отображения страниц и компонентов приложения.
• Каталог aurora содержит исходный код на C++ и ресурсы необходимые для установки.
  • Каталог desktop содержит настройки сборки rpm-пакета.
    • Файл ru.auroraos.DivKit.desktop определяет отображение и параметры запуска приложения.
  • Каталог icons содержит иконки приложения для поддерживаемых разрешений экрана.
  • Каталог rpm содержит настройки сборки rpm-пакета.
    • Файл ru.auroraos.DivKit.spec используется инструментом rpmbuild.
  • Файл CMakeLists.txt описывает структуру проекта для системы сборки cmake.
  • Файл main.cpp является точкой входа в приложение.
• Каталог lib содержит реализации приложения на Dart.
• Файл pubspec.yaml определяет конфигурацию проекта и используется, чтобы определить зависимости проекта.

Правила использования и участие в разработке

Часть проекта предоставляется по лицензии, которая позволяет использовать его в сторонних приложениях.
Другая предоставляется по лицензиям.

Соглашение участника регламентирует права, предоставляемые участниками компании «Открытая Мобильная Платформа».

Информация об участниках указана в файле AUTHORS.

Кодекс поведения — это действующий набор правил компании «Открытая Мобильная Платформа», который информирует об ожиданиях по взаимодействию между членами сообщества при общении и работе над проектами.