Skip to content

sheffcer/start-project-SASS

Repository files navigation

Стартовый проект с gulp Test Status devDependencies Status dependencies Status

Команда Результат
npm i Установить зависимости
npm start Запустить сборку, сервер и слежение за файлами
npm start ЗАДАЧА Запустить задачу с названием ЗАДАЧА (список задач в ./gulpfile.js)
Оптимизация изображений из папки ./src/img (или любой другой)
npm run build Сборка проекта без карт кода (сжатый вид, как результат работы)
npm run deploy Сборка проекта без карт кода и отправка содержимого папки сборки на github-pages
npm run test:style Проверка стилевой составляющей проекта stylelint

Предполагается, что все команды вы выполняете в bash (для OSX и Linux это самый обычный встроенный терминал, для Windows это, к примеру, Git Bash). В Windows установку пакетов (npm i) нужно выполять в терминале, запущенном от имени администратора.

Как начать новый проект c этим репозиторием

  1. Клонировать этот репозиторий в новую папку ([email protected]:sheffcer/start-project-SASS.git, см. шпаргалку) и зайти в неё (cd new-project).
  2. Стереть историю разработки этого репозитория (rm -rf .git), инициировать новый (git init), создать удалённый репозиторий и привязать его (git remote add origin АДРЕС, см. шпаргалку).
  3. Отредактировать README.md, package.json (название проекта, автор, лицензия, сторонние пакеты и пр.).
  4. Установить зависимости (npm i).
  5. Запустить сервер разработки (npm start).

линтером).

Парадигма

  • Именование классов по БЭМ, разметка в pug и стилизация Sass. См. Как работать с CSS-препроцессорами и БЭМ
  • Каждый БЭМ-блок в своей папке внутри ./src/blocks/.
  • Список использованных в проекте БЭМ-блоков и доп. файлов указан в ./projectConfig.json. Это главный конфигурационный файл проекта.
  • Есть глобальные файлы: стилевые (стили печати), js (по умолчанию пуст), шрифты, картинки.
  • Диспетчер подключения стилей ./src/scss/style.scss генерируется автоматически при старте любой gulp-задачи (на основе данных из ./projectConfig.json).

Разметка

HTML никак не обрабатывается.

Стили

Файл-диспетчер подключений (./src/scss/style.scss)

Назначение папок

build/          # - Папка сборки, здесь работает сервер автообновлений.
  blocks/       # - блоки проекта.
  css/          # - добавочные css-файлы
  favicon/      # - файлы для фавиконок и смежных технологий.
  fonts/        # - шрифты проекта (будут автоматически скопированы в папку сборки).
  img/          # - картинки
  js/           # - js-файлы
  scss/         # - стили (файл style.scss скомпилируется

  

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published