README

Скелетон основан на Yii2 модулях Dvizh и сторонних разработчиков, предназначен для быстрой сборки MVP (минимально жизнеспособный продукт) Интернет-магазина. Данное решение навязывает свою модульно-аспектную архитектуру приложения, направленную на

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

Демо: http://demo-dss.dvizh.net (это фронт с основными виджетами) http://demo-dss.dvizh.net/backend/web (это админка)

administrator:10111988

Целевая аудитория - опытные программисты.

Скелетон имеет высокий порог входа по сравнению с CMS. Для того, чтобы собрать магазин на готовых модулях Dvizh, нужно знать:

PHP (синтаксис ООП обязателен)
HTML
Yii2 фреймворк
Git

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

Скелетон - базовый каркас приложения, зависящий от некоторых модулей и содержаший в себе аспекты с информацией о том, как модули связываются в рамках обслуживаемой предметной области;
Модуль - максимально изолированный от других модулей набор классов;
CRUD - контроллеры и вью файлы, формирующие и сохраняющие данные через модели;
Сервис - экземпляр объекта (как правило, синглтон), доступный глобально в системе через yii::$app->serviceName и предоставляющий API для работы с какими-дибо данными;
Событие - некоторое событие в модуле, которое потенциально может "заинтересовать" другие модули и само приложение. Подписчики события могут повлиять на логику выполнения программы, в которой это событие произошло. Аналог хуков в WordPress;
Модель - AR модель, содержашая геттеры\сеттеры сущности и примитивное API для работы с данными сущности;
Виджет - переносимый HTML кода с CSS и JS обработчиками. Аналог компонента в Битриксе;
Аспект - коллбек, знающий о всех модулях в системе и реагирующий на события в этих модулях. Как правило, реализуется посредством поведений Yii2. С точки зрения архитектуры приложения скелетона Dvizh, аспект находится на пересечении модулей. Например, при создании заказа через модуль "заказ", этот заказ должен заполняться элементами модуля "корзины" - именно эту работу выполняет аспект;

Модули

Используемые в скелетоне важные модули:

dvizh/yii2-shop - CRUD для управления товарами, модификациями, ценами, категориями, производителями, значениями фильтров;
dvizh/yii2-filter - CRUD для фильтров на сайте, набор виджетов для быстрого применения фильтов на фронте с помощью Ajax;
dvizh/yii2-field - CRUD управления кастомными полями любой AR сущности;
dvizh/yii2-gallery - виджет загрузки картинок, виджет вывода картинок в виде галереи;
dvizh/yii2-seo - виджет позволяет прикреплять к моделям важные для SEO поля;
dvizh/yii2-order - CRUD заказов, набор виджетов для создания заказа и с аналитическими отчетами о заказах за период;
dvizh/yii2-cart - сервис и набор виджетов для быстрой разработки функционала корзины на сайте. В корзину можно положить любую модель, имплементируюущую нужный интерфейс;
dvizh/yii2-promocode - CRUD для управления скидками на сайте, сервис работы со скидками;
dvizh/yii2-certificate - CRUD для управления подарочными сертификатами на сайте, сервис работы со скидками;
dektrium/yii2-user - CRUD управления пользователями сайта;
dektrium/yii2-rbac - RBAC для сайта.

Установка

Существует два способа установки модулей:

Через клонирование репозитория Git'ом в кастомную папку Yii2 проекта и подключение модуля в секции autoload composer.json файла (+выполните composer update). Не забудьте подключить модуль в секции bootstrap, extensions и modules конфига (по аналогии с модулем от dektrium в данном скелетоне)
Через Composer:

composer create-project --prefer-dist --stability=dev dvizh/shop-skeleton

Выполните git init. Вы создали свою собственную ветку DSS, осталось собрать с помощью виджетов фронт нужного заказчику сайта.

Выполните следующую команду в корне проекта:

php init

Обновите Composer:

composer update

Настройте подключение к БД в следующих файлах:

*/commom/config/main-local.php */console/config/main-local.php

Выполнение миграций модулей:

sh migrate.sh

Если у вас стоит Apache, на этом всё, .htaccess файлы идут в составе скелетона, все запросы пользователя будут направления на /frontend/web. Если Apache нет, то придется еще настроить точки входа для фронтенда (frontend/web) и бекенда (backend/web).

Панель администрирования по умолчанию:

/backend/web/

administrator:10111988

Кастомизация

Рассмотрим основные способы кастомизации модулей без вынесения их в отдельную Git ветку.

Большинство модулей, сервисов и виджетов имеют настройки для гибкой интеграции в интерфейс и бизнес-процессы типичного проекта. Позже все будет описано в документации;
Через создание дополнительного поля в модуле dvizh/yii2-field. Модули предлагают только CRUD бекенда, фронт пишется своими силами и в нем можно использовать API модуля yii2-field для поиска записей по кастомным полями и для вывода их содержимого;
Через viewPath. Когда нужно добавить дополнительную колонку в GridView и т.д.;
Через controllerMap модуля. Когда нужно добавить поле в модель и модуль dvizh/yii2-field уже не подходит;
Через контрибьюцию. Если вы создали виджет, который может быть потенциально полезен сообществу или создали полезный метод в существующем API - добро пожаловать в контрибьюторы. Сделайте форк и пулл-реквест, тоталитарное руководство рассмотрит предлжение. Если это изменение несет в себе полезный для всех функционал, а не закрытие частного возражения, правка будет принята в центральный репозиторий;
Через отдельную ветку. Самый нежелательный вариант, сигнализирующий о том, что проект перерос MVP. Вы можете формнуть модуль и вести независимую разработку.

Использование

Использовать компоненты модулей нужно согласно документации этих модулей (пока что все в файле README).

dvizh / shop-skeleton

Maintainers

Details

README

Модули

Установка

Кастомизация

Использование