/craft-boilerplate

SNP Craft CMS Project Boilerplate

Primary LanguagePHPMIT LicenseMIT

SNP Craft CMS Project Boilerplate

Cодержание
  1. Установка
  2. Разработка
  3. Структура
  4. Лицензия

Установка

  1. Склонируйте этот репозиторий:

    git clone https://github.com/snphq/craft-boilerplate.git

  2. Установка зависимостей Craft CMS (выберите один из вариантов установки)

    1. Установка MAMP

      1. Скачайте и установите MAMP
      2. Запустите MAMP.
      3. Выберите Preferences...
      4. Выберите вкладку ports
      5. Нажмите на кнопку Set WEB & MySQL ports to 80 & 3306 (используя MAMP необходимо настроить apatch на 80 порт, так как на других портах есть проблема с загрузкой асетов через админку)
      6. Перейдите на вкладку Web Server, выберите Apatch и папку public вашего проекта
      7. Закройте настройки и нажмите Start Servers
      8. Нажмите Open WebStart page, выберите Tools -> phpMyAdmin
      9. Создайте новую базу данных или импортируйте craft_example

    2. Глобальная установка

      1. Установите необходимые зависимости в соответствии с Craft CMS requirements

      2. Создайте новую базу данных или импортируйте craft_example

  3. Установка зависимостей системы сборки

    1. Установите Node.js версии 6 или выше, если не установлен.
    2. Выполните npm i

  4. Настройка Craft CMS

    1. Выполните шаги 2, 4, 5 из раздела Installing

Разработка

  1. Выполните npm start для запуска системы сборки в watch режиме.
  2. Откройте соответсвующий локальный хост в браузере (по умолчанию http://localhost)

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

craft - здесь находятся файлы CraftCMS
  app - ядро CMS
  config - файлы конфигурации
  plugins - директория с плагинами
  storage - служебные файлы CMS
generator - модуль для генерации страниц, контейнеров и компонентов через консоль
public - корневая директория для web сервера
  build - директория с ресурсами, сгенерированными системой сборки
  static - директория со статическими ресурсами
    fonts - директория для шрифтов
    images - директория для изображений
    templates - корневая директория, относительно которой CMS ищет шаблоны
      _components - директория для шаблонов компонентов
      _containers - директория для шаблонов контейнеров
      _pages - директория для шаблонов страниц
      _webpack.templates - шаблоны, сгенерированные системой сборки
      _layout - базовый шаблон для страниц
  uploads - папка для загрузки ресурсов через CMS (не отслеживается системой контроля версий, при необходимости создать самостоятельно)
src - папка с исходными ресурсами приложения
  components - директория c компонентами
  containers - директория с контейнерами
  pages - директоря со страницами
  styles - директория с глобальными стилями и константами
  utils - директория для утилит
  _webpack.templates - директория с базовыми шаблонами, в которые будут добавлены ресурсы, соранные системой сборки
  favicon.png - фавикон для сайта
  global.js - файл с глобальными скриптами и зависимостями
  router.js - файл, где описываются зависимости относительно текущего роута
utils - директория для утилит уровня приложения
webpack.config - файлы конфигурации системы сборки
.babelrc - файл конфигурации babel
.editorconfig - файл конфигурации плагина EditorConfig для редактора кода
.eslintignore - файл, описывающий исключения для ESLint
.eslintrc.js - файл конфигурации ESLint
LICENSE.txt - файл с лицензией
package-lock.json - файл конфигурации nodejs (генерируется npm)
package.json - файл конфигурации nodejs
postcss.config.js - файл конфигурации postcss
README.md - файл README
webpack.config.js - корневой файл конфигурации системы сборки