{"id":22181196,"url":"https://github.com/viclafouch/gulp-example","last_synced_at":"2025-07-15T13:10:46.036Z","repository":{"id":101815623,"uuid":"106523549","full_name":"viclafouch/Gulp-example","owner":"viclafouch","description":"An example of Gulpfile that allows you to create your own stand-alone project to facilitate several tasks.","archived":false,"fork":false,"pushed_at":"2018-04-01T17:35:39.000Z","size":307,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-24T19:18:57.521Z","etag":null,"topics":["gulp","gulpfile-js","javascript","nodejs","structuremap"],"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/viclafouch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-10-11T07:58:58.000Z","updated_at":"2018-06-16T19:20:04.000Z","dependencies_parsed_at":"2023-03-12T00:01:21.979Z","dependency_job_id":null,"html_url":"https://github.com/viclafouch/Gulp-example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/viclafouch/Gulp-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viclafouch%2FGulp-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viclafouch%2FGulp-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viclafouch%2FGulp-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viclafouch%2FGulp-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/viclafouch","download_url":"https://codeload.github.com/viclafouch/Gulp-example/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viclafouch%2FGulp-example/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265437617,"owners_count":23765124,"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":["gulp","gulpfile-js","javascript","nodejs","structuremap"],"created_at":"2024-12-02T09:27:02.569Z","updated_at":"2025-07-15T13:10:45.969Z","avatar_url":"https://github.com/viclafouch.png","language":"JavaScript","readme":"# [Gulp-example]\r\n\r\nExample of a gulpfile which build your own project (good for beginners).\r\n\r\n## Informations\r\n\r\n\u003ctable\u003e\r\n\u003ctd\u003eDescription\u003c/td\u003e\r\n\u003ctd\u003eA complete gulpfile for your project\u003c/td\u003e\r\n\u003c/tr\u003e\r\n\u003ctr\u003e\r\n\u003ctd\u003eNode Version\u003c/td\u003e\r\n\u003ctd\u003e\u003e= 0.10\u003c/td\u003e\r\n\u003c/tr\u003e\r\n\u003ctr\u003e\r\n\u003ctd\u003eRuby Version\u003c/td\u003e\r\n\u003ctd\u003e\u003e= 2.0\u003c/td\u003e\r\n\u003c/tr\u003e\r\n\u003ctr\u003e\r\n\u003ctd\u003eCompass\u003c/td\u003e\r\n\u003ctd\u003e\u003e= 1.0.1\u003c/td\u003e\r\n\u003c/tr\u003e\r\n\u003c/table\u003e\r\n\r\n## Description\r\n\r\nThis example of Gulpfile will allow you to create your own autonomous project to facilitate several tasks: concatenation of files, compression and minification, auto-refresh and auto-prefix for your css.\r\n\r\nA simple configuration file : **gulpfile.js**\r\n\r\n![demo](https://cdn.rawgit.com/viclafouch/Gulp-example/138951f9/gulp-example.gif)\r\n\r\nHere is the list of the gulp plugins used : \r\n\r\n* [babel-core](https://github.com/babel/babel/tree/master/packages/babel-core)\r\n* [babel-preset-es2015](https://github.com/babel/babel/tree/master/packages/babel-preset-es2015)\r\n* [browserslist](https://github.com/ai/browserslist)\r\n* [gulp-about](https://github.com/michaelbazos/gulp-about)\r\n* [gulp-autoprefixer](https://github.com/sindresorhus/gulp-autoprefixer)\r\n* [gulp-babel](https://github.com/babel/gulp-babel)\r\n* [gulp-clean-css](https://github.com/scniro/gulp-clean-css)\r\n* [gulp-concat](https://github.com/contra/gulp-concat)\r\n* [gulp-if](https://github.com/robrich/gulp-if)\r\n* [gulp-inject](https://github.com/klei/gulp-inject)\r\n* [gulp-json-editor](https://github.com/morou/gulp-json-editor)\r\n* [gulp-livereload](https://github.com/vohof/gulp-livereload)\r\n* [gulp-print](https://github.com/alexgorbatchev/gulp-print)\r\n* [gulp-rename](https://github.com/hparra/gulp-rename)\r\n* [gulp-sourcemaps](https://github.com/gulp-sourcemaps/gulp-sourcemaps)\r\n* [gulp-uglify](https://github.com/terinjokes/gulp-uglify)\r\n* [gulp-webserver](https://github.com/schickling/gulp-webserver)\r\n* [gulp-util](https://github.com/gulpjs/gulp-util)\r\n* [run-sequence](https://www.npmjs.com/package/run-sequence)\r\n\r\n## Usage\r\n\r\n4 requirements are necessary to use Gulp-example : **Gulp**, **NodeJS**, **Ruby** and **Compass** are required.\r\n\r\n* Gulp : https://gulpjs.com/\r\n* NodeJs : https://nodejs.org/en/download/\r\n* Ruby : https://www.ruby-lang.org/en/downloads/\r\n* Compass :  http://compass-style.org/install/\r\n\r\nIf you want to have an autorefresh on your browser, you need livereload\r\n* http://livereload.com/extensions/ and choose your browser.\r\n\r\nAfter cloning the project, run these commands bellow :  \r\n\r\n```\r\nnpm install\r\n```\r\n\r\n```\r\ngulp\r\n```\r\n\r\n## Configuration\r\n\r\n### inDev\r\n\r\n- Type: `Boolean`\r\n- Default: `true`\r\n\r\nDefine your environment.\r\n\r\n\r\n### libName\r\n\r\n- Type: `String`\r\n- Default: `lib`\r\n\r\nDefine your library folder name.\r\n\r\n### libJS\r\n\r\n- Type: `Array`\r\n- Default: `[]`\r\n\r\nInclude all your js library.\r\n\r\n**Note:** Be careful, It has to be the name of the folder which contains the differents js files.\r\n\u003cbr/\u003e\r\n**Example of a path** :  `lib/MyLib/script.js` **=\u003e** `['MyLib']`\r\n\r\n### assetsPath\r\n\r\n- Type: `String`\r\n- Default: `assets`\r\n\r\nDefine your assets folder name.\r\n\r\n### jsFileName\r\n\r\n- Type: `String`\r\n- Default: `app`\r\n\r\nDefine the name of the script file. All of the libraries that you included will be there (with your script).\r\n\r\n### jsFolder\r\n\r\n- Type: `String`\r\n- Default: `js`\r\n\r\nDefine your js folder name.\r\n\r\n### cssFolder\r\n\r\n- Type: `String`\r\n- Default: `css`\r\n\r\nDefine your css folder name.\r\n\r\n### scssFolder\r\n\r\n- Type: `String`\r\n- Default: `scss`\r\n\r\nDefine your scss folder name.\r\n\r\n### imgFolder\r\n\r\n- Type: `String`\r\n- Default: `img`\r\n\r\nDefine your img folder name.\r\n\r\n### jsonData\r\n\r\n- Type: `Object`\r\n- Options:\r\n  - `'description'`: `` =\u003e `String`\r\n  - `'version'`: `` =\u003e `String`\r\n  - `'author'`: `` =\u003e `String`\r\n\r\nDefine some information about your project.\r\n\r\n### autoRefresh\r\n\r\n- Type: `Boolean`\r\n- Default: `true`\r\n\r\nYou can listen for changes and allow auto-refresh based on [livereload for browser](http://livereload.com/extensions/).\r\n\r\n## Contribute\r\n\r\nAny contributions and/or pull requests would be welcome.\r\n\r\nBug fixes are greatly appreciated.\r\n\r\n## License\r\n\r\nGulp-example is licensed under the [MIT](http://www.opensource.org/licenses/mit-license.php) license:\r\n\r\nCopyright (C) 2017 Victor de la Fouchardiere\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r\n\r\n## Author\r\n[Victor de la Fouchardière](http://www.victor-de-la-fouchardiere.fr/)\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviclafouch%2Fgulp-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fviclafouch%2Fgulp-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviclafouch%2Fgulp-example/lists"}