{"id":21178939,"url":"https://github.com/joseffie/gulp-joseffie-settings","last_synced_at":"2025-03-14T18:44:16.436Z","repository":{"id":38029347,"uuid":"473253340","full_name":"joseffie/gulp-joseffie-settings","owner":"joseffie","description":"Gulp.js settings + Start template for front-end developers.","archived":false,"fork":false,"pushed_at":"2023-11-11T14:23:30.000Z","size":2936,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-21T11:45:34.314Z","etag":null,"topics":["bem","bem-tools","css","development-environment","development-tools","development-workflow","es6","eslint","gulp","html","json","pug","sass","scss","starter-project","starterkit","webpack"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joseffie.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-03-23T15:41:09.000Z","updated_at":"2024-01-12T18:28:36.000Z","dependencies_parsed_at":"2023-11-11T15:26:35.039Z","dependency_job_id":"16e899ce-e249-40ce-b64c-bdd970286ed1","html_url":"https://github.com/joseffie/gulp-joseffie-settings","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joseffie%2Fgulp-joseffie-settings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joseffie%2Fgulp-joseffie-settings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joseffie%2Fgulp-joseffie-settings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joseffie%2Fgulp-joseffie-settings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joseffie","download_url":"https://codeload.github.com/joseffie/gulp-joseffie-settings/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243629540,"owners_count":20322075,"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":["bem","bem-tools","css","development-environment","development-tools","development-workflow","es6","eslint","gulp","html","json","pug","sass","scss","starter-project","starterkit","webpack"],"created_at":"2024-11-20T17:27:23.757Z","updated_at":"2025-03-14T18:44:16.417Z","avatar_url":"https://github.com/joseffie.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gulp-joseffie-settings\n\n\u003e Gulp-based starter template for better front-end coding with [Pug](https://pugjs.org/) and [SCSS](https://sass-lang.com/guide) preprocessors\n\n## Documentation\n\nMore information see in [docs](./docs/) folder\n\n## Core features\n\n- Component approach with BEM based.\n- Automatic creation of component directories with files using the [bem-tools-create](https://github.com/bem-tools/bem-tools-create) tool.\n- Automatic compilation of fonts to woff/woff2 and file creation with @font-face.\n- Automatic icon system based on SVG Symbols.\n- Checking for errors on commit.\n- Using a hard code guide.\n\n## Quickstart\n\nMake sure you have [Node.js](https://nodejs.org/en/) installed.\n\n1. Install the [Yarn](https://yarnpkg.com/) globally:\n\n```console\n$ npm i -g yarn\n```\n\n2. Install the [Gulp](https://gulpjs.com/) and [bem-tools](https://en.bem.info/) globally:\n\n```console\n$ yarn global add gulp bem-tools-core bem-tools-create\n# or\n$ npm i -g gulp bem-tools-core bem-tools-create\n```\n\n3. Clone the project:\n\n```console\n$ git clone https://github.com/joseffie/gulp-joseffie-settings.git my-project\n```\n\n4. Go to the project and install needed dependencies:\n\n```console\n$ yarn\n```\n\n5. After installing the dependencies, you may start the dev server:\n\n```console\n$ yarn run dev\n```\n\n## CLI\n\n|    Command    |                                                       Description                                                       |\n| :-----------: | :---------------------------------------------------------------------------------------------------------------------: |\n|      dev      |                                           runs the build in development mode                                            |\n|     build     |    optimizes source files, converts preprocessor files into browser-understandable files, and sends to `dist` folder    |\n|      zip      |                                          runs `build` and archives the project                                          |\n|   build:pug   |                                        optimizes page files and pushs to `dist`                                         |\n| build:styles  |                                        optimizes style files and pushs to `dist`                                        |\n| build:scripts |                                         optimizes JS files and pushs to `dist`                                          |\n| build:images  |                                          optimizes images and pushs to `dist`                                           |\n|  build:fonts  |       converts local fonts to woff/woff2 formats, automatically generate SCSS file with `@font-face` declarations       |\n| build:sprites |                                            converts SVG icons to SVG sprite                                             |\n|    deploy     |                         runs `build`, then pushs the build to GitHub Pages (`gh-pages` branch)                          |\n|    publish    |                                   pushs the build to GitHub pages without run `build`                                   |\n|   lint:pug    |                                               checks Pug code for errors                                                |\n|  lint:styles  | checks SCSS code for errors. If you specify the `--fix` flag, then the errors will be automatically fixed by the linter |\n| lint:scripts  |  checks JS code for errors. If you specify the `--fix` flag, then the errors will be automatically fixed by the linter  |\n\n## Component generator\n\nCreate empty component by name in `src/components` folder.\n\nBy default generates only `*.pug`, `*.scss` and `*.js` files.\n\nSyntax:\n\n```console\n$ bem create \u003ccomponent-name\u003e \u003cargs\u003e\n```\n\nIf you need to create only one file type, use the `-T` flag:\n\n```console\n$ bem create header -T pug\n```\n\nIf you need to remove one or more default file types, use the `-n` flag:\n\n```console\n$ bem create header -n js\n```\n\nIf you need to add another file type to your component folder, use the `-t` flag:\n\n```console\n$ bem create header -t md\n```\n\nYou can also combine flags:\n\n```console\n$ bem create menu -n js -t yml\n```\n\n## License\n\n[The GPL3.0 License (GPL3.0 only)](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoseffie%2Fgulp-joseffie-settings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoseffie%2Fgulp-joseffie-settings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoseffie%2Fgulp-joseffie-settings/lists"}