Руководство

🏷️ Содержание

• Требования
• Установка
• Команды
• Структура проекта
• Технологии
• Лицензия

✒️ Требования

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

• Node.js
• Yarn
• Git

💾 Установка

Инcтрукции данного раздела следует выполнять в командной строке.

# Скачайте репозиторий
git clone https://github.com/AkhmadBabaev/webpack-mp

# Перейдите в папку с репозиторием
cd webpack-mp

# Установите зависимости
yarn install

📗 Команды

• yarn clear - удаляет папку /dist.

• yarn dev - запускает development сборку, поднимает локальный сервер с результатом cборки по адресу http://localhost. Не сохраняет результат в файловой системе. Детали работы в webpack.dev.js.

• yarn start - дополняет команду yarn dev тем, что запускает ваш браузер по умолчанию (если он не запущен), создает вкладку с адресом лок. сервера и переходит к ней.

• yarn prod - запускает production сборку и сохраняет результат в папку /dist. Детали работы в webpack.prod.js.

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

/src - служит для хранения исходников.

/public - для хранения файлов которые не нужно обрабатывать webpack'ом.

/dist - для результата сборки проекта.

/config - предназначен для конфигурационных файлов webpack и файлов имеющих к ним отношение.

🛠️ Технологии

Сборка проекта осуществляется с помощью Webpack.

• Разметка: Pug.
• Стили: SCSS, PostCSS, BEM.
• Сценарии: JS, ESLint, Babel.
• Настройки редактора: EditorConfig.

📃 Лицензия

Этот проект лицензирован на условиях лицензии MIT.

Вы можете ознакомиться с содержанием лицензии здесь.