Установка

Инструкция по установке.

Оглавление страницы:

Шаг 1 

Скачать или клонировать Gulp сборку.

git clone git@github.com:eliofery/gulp-template.git

Шаг 2 

Установить зависимости.

npm i

Шаг 3 

Загрузите свою svg favicon в каталог ./src/assets/favicons с именем icon.svg.

Favicon должен быть размером не менее 512x512, например:

HTML
<svg xmlns="http://www.w3.org/2000/svg" width="512" height="512">...</svg>

При сборке проекта на основе icon.svg будут созданы другие необходимые favicons.

Шаг 4 

Отредактировать файл package.json, изменив название, описание, версию проекта, ссылки на репозиторий и т.д.

Внести изменения в файл ./gulp/config.js, в разделе replacement, согласно наименованию вашего проекта. Изменять следует только свойство new, например:

JS
...
// Замена текста в файлах
replacement: {
  env: { old: 'dev', new: 'prod' },
  url: { old: 'http://localhost', new: 'https://site.domen' },
  title: { old: 'Название сайта', new: 'Новое имя сайта' },
  desc: { old: 'Описание сайта', new: 'Новое описание сайта' },
  version: { old: '1.0.0', new: '2.0.0' },
  color: { old: '#000', new: '#777' },
},
...

Gulp будет искать значения прописанные в параметрах old и менять их на значения параметров new, в файлах:

JS
// Файлы в которых производится замена текста
files: [
`${srcPath}}/assets/manifest.json`,
`${srcPath}}/pug/data/config.pug`,
`${srcPath}/pug/pages/index.pug`,
],

После чего выполните команду, которая заменит текст:

npm run replaces

Или, чтобы заменить текст и автоматически удалить промо страницу с инструкцией, выполните команду:

npm run preperate

Шаг 5 

Теперь вы готовы приступить к верстке своего проекта.

Соберет проект и запустит Live Server в режиме разработки. Файлы не будут минифицированы, а картинки оптимизированы.

npm run dev

Соберет проект в режиме продакшн. Файлы будут минифицированы, а картинки оптимизированы.

npm run build

Запустит Live Server без компиляции проекта. Если не хочется заново компилировать проект, а только запустить сервер.

npm run proxy

Если при сборке возникнет ошибка: DSO support routines:DLFCN_LOAD:could not load the shared library:dso_dlfcn.c:185:filename(libproviders.so).

Обнулите значение переменной OPENSSL_CONF:

export OPENSSL_CONF=/dev/null