{"id":14967555,"url":"https://github.com/crecotun/fabium","last_synced_at":"2025-10-25T20:31:35.807Z","repository":{"id":16285758,"uuid":"19034266","full_name":"crecotun/fabium","owner":"crecotun","description":"+100 for productivity","archived":false,"fork":false,"pushed_at":"2021-12-11T18:52:57.000Z","size":3542,"stargazers_count":108,"open_issues_count":7,"forks_count":19,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-10-30T02:28:24.368Z","etag":null,"topics":["autoprefixer","browsersync","javascript","postcss","pug","sugarss","task-runner"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crecotun.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-04-22T15:09:01.000Z","updated_at":"2024-02-13T15:41:52.000Z","dependencies_parsed_at":"2022-08-25T12:41:21.412Z","dependency_job_id":null,"html_url":"https://github.com/crecotun/fabium","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crecotun%2Ffabium","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crecotun%2Ffabium/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crecotun%2Ffabium/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crecotun%2Ffabium/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crecotun","download_url":"https://codeload.github.com/crecotun/fabium/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238207645,"owners_count":19434095,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autoprefixer","browsersync","javascript","postcss","pug","sugarss","task-runner"],"created_at":"2024-09-24T13:38:15.584Z","updated_at":"2025-10-25T20:31:30.428Z","avatar_url":"https://github.com/crecotun.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Front-end automated boilerplate\n====================\n\n## How to use\n1. Install deps `npm i`\n2. Run `npm run prepare`\n3. all tasks should be started via npm. e.g. `npm run gulp`, `npm run gulp dev`.\n\tIt looks a bit ugly, but this is the only way to work with 4 ver of gulp until it'll be finally released.\n\n## So, what do we have under the hood for now?\n- pug -\u003e html\n- sass -\u003e postcss -\u003e css\n- browsersync\n- autoprefixer\n- es2015 compilation\n- watch 'n compile\n- generator for styles and templates\n\nBoilerplate for UI development\n\n## Навигация\n* [What is this?](#What is this)\n* [Installation](#Installation)\n* [Что в мешке?](#Что-в-мешке)\n    * [Сборщик проекта](#Сборщик-проекта)\n    * [Автоматизированные задачи](#Автоматизированные-задачи)\n    * [Файловая структура](#Файловая-структура)\n* [Как все работает?](#Как-все-работает)\n    - [Задачи](#Задачи)\n    - [Группы задач](#Группы-задач)\n* [TODO](#TODO)\n\n## What is this?\nThis is a boilerplate for reducing amount of routine tasks in UI development.\nThe boilerplate is built based on my experience and needs, so I don't guarantee it will be useful for you as is. You can use it as an example and modify it or build your own.\n\n## Intallation\n- Download and install [node.js](https://nodejs.org/)\n- Clone this repository and remove `.git` in order to connect your own git repository later\n- Install all dependencies `npm i`\n- Run `npm run prepare`\n\n## Что в мешке?\n\n### Автоматизированные задачи\n- Компиляция es2015\n- Компиляция [Jade](http://jade-lang.com/)-шаблонов\n- PostCSS с синтаксисом sugarss\n- Добавление вендорных префиксов к свойствам\n- Минификация css и js\n- Оптимизация картинок\n- авто-обновление браузера\n- подготовка стилей `rtl`\n- загрузка зависимостей js через npm\n- загрузка файлов на сервер по ssh\n- Валидация html на w3c\n- архивирование файлов `dist` и `src` папок\n- слежение за изменениями файлов\n- генерация файлов стилей и шаблонов\n- stylelint\n\n### PostCSS plugins\n- sugarss\n- postcss-scss\n- postcss-import\n- precss\n- postcss-inline-svg\n- postcss-assets\n- postcss-svgo\n- postcss-hexrgba\n- postcss-sass-color-functions\n- postcss-short\n- autoprefixer\n\n### Файловая структура\n\n- `gulpfile.js` — папка в которой лежит `gulpfile` и таски.\n- `src` — исходные файлы проекта\n- `dist` — результат билда\n\n**Содержимое папки `src`**\n- `assets`\n\t+ `styles` — стили проекта\n\t\t- `common`\n\t\t- `components`\n\t\t- `helpers`\n\t+ `images` — картинки проекта, включая `content` папку для картинок в контенте\n\t+ `scripts` — скрипты\n- `templates`\n\t+ `pages` — шаблоны страниц\n\t+ `components` — блоки из которых будут собираться страницы.\n\t+ `partials`\n\t+ `layout`\n\n## Как все работает?\nВ `gulpfile.js/index.js` описаны таски, которые выполняют те или иные действия. Таски можно вызывать по отдельности и группами. Вызов группами — самый частый юзкейс.\nВсе `gulp`-плагины загружаются автоматически из `package.json` с помощью плагина `gulp-load-plugins`. Это позволяет уменьшить объем `gulpfile`.\n`Gulp` в процессе работы берет файл из 1 папки, выполняет с ним необходимые операции и сохраняет в другой папке. Для удобства, все пути к файлам я вынес в переменные и храню их в файле `config.json`.\n\n### Генератор файлов\nВ процессе работы много времени уходит на создание файлов для компонентов и страниц. Я решил это дело автоматизировать.\nТеперь одной командой `npm run addFile` можно создать:\n- стиль для компонента\n- миксин\n- шаблон для компонента\n- и страницу\n\nПри создании стиля для компонента, можно создать файл для респонсив версии, и все это автоматически подключится в main.scss\nПри создании новой страницы, она добавится в список всех страниц в файле index.pug\n\n### Задачи\nВсе задачи запускаются посредством npm scripts.\n\n#### NPM\n- `npm start` — запуск `gulp dev`. Чтобы запустить browsersync на другом порту, можно писать `PORT=8080 npm start`\n- `npm run production` — запуск `gulp production`\n- `npm run deploy` — запуск `gulp deploy`\n- `npm run validate` — запуск `gulp validate`\n- `npm run minify` — запуск `gulp minify`\n- `npm run add` — запуск генератора файлов\n\n#### Gulp\n\n##### Отдельные\n- `styles` — компиляция sass\n- `styles:min` — минификация `csso`\n- `styles:rtl` — вариант стилей справа-налево\n- `scripts` — компиляция es2015\n- `scripts:min` — минификация js\n- `images` — перенос картинок из `src` в `dist`\n- `images:min` — оптимизация картинок в `dist`\n- `templates` — компиляция jade-шаблонов\n- `sprites` — сборка спрайтов\n- `watch` — слежение за изменениями файлов\n- `browsersync` — автообновление в браузере\n- `archive` — архивация `dist` и `src` папок\n- `archive:dist` — архивация `dist`\n- `archive:src` — архивация `src`\n- `ssh` — запуск задач `ssh:clean`, `ssh:upload`, `ssh:unzip`\n- `ssh:clean` — заходит на сервер, чистит папку проекта\n- `ssh:upload` — загружает на сервер архив `dist` папки\n- `ssh:unzip` — распаковывае на сервере `dist` архив и удаляет его\n- `w3c:html` — валидация html кода\n\n##### Группы\n- `default` — `bower`, `images`, `styles`, `scripts`, `templates`, `sprites`\n- `dev` — `default`, `browsersync`, `watch`\n- `minify` — `images:min`, `styles:min`, `scripts:min`\n- `production` — `default`, `styles:rtl`, `minify`\n- `deploy` — `production`, `archive`, `ssh`\n- `validate` — `w3c:html`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrecotun%2Ffabium","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrecotun%2Ffabium","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrecotun%2Ffabium/lists"}