{"id":20307153,"url":"https://github.com/jadbox/gulps","last_synced_at":"2025-06-30T20:38:54.141Z","repository":{"id":142019072,"uuid":"47471599","full_name":"jadbox/gulps","owner":"jadbox","description":"Universal boilerplate for creating libraries","archived":false,"fork":false,"pushed_at":"2015-12-05T15:58:35.000Z","size":113,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-04T07:32:12.761Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"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/jadbox.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}},"created_at":"2015-12-05T20:30:44.000Z","updated_at":"2016-04-01T01:38:13.000Z","dependencies_parsed_at":"2023-03-14T14:01:14.443Z","dependency_job_id":null,"html_url":"https://github.com/jadbox/gulps","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/jadbox/gulps","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadbox%2Fgulps","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadbox%2Fgulps/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadbox%2Fgulps/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadbox%2Fgulps/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jadbox","download_url":"https://codeload.github.com/jadbox/gulps/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadbox%2Fgulps/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262847342,"owners_count":23373980,"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":[],"created_at":"2024-11-14T17:16:27.335Z","updated_at":"2025-06-30T20:38:54.041Z","avatar_url":"https://github.com/jadbox.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Universal (isomorphic) boilerplate written in ES2015 for Node and the browser.\n\n[![Travis Status][trav_img]][trav_site]\n[![devDependency Status](https://david-dm.org/kflash/gulps/dev-status.svg)](https://david-dm.org/kflash/gulps#info=devDependencies)\n[![Dependency Status](https://david-dm.org/kflash/gulps.svg)](https://david-dm.org/kflash/gulps)\n\n\u003e A starter kit to get you up and running with a bunch of awesome new front-end technologies using Gulp, Babel, Webpack, Mocha, Sinon-chai, Isparta, and ESLint without any framework dependencies.\n\n## Requirements\n\nNode `\u003e= 4.1`.\n\n## Features\n\n\n* [ES6 with Babel](http://babeljs.io/) for ES6 and ES7\n* [Webpack](https://webpack.github.io/) for bundling\n* [Eslint](http://eslint.org/) to maintain a consistent code style\n* [Gulp](https://github.com/gulpjs/gulp) as build system\n* [Universal Module Definition (UMD) API](https://github.com/umdjs/umd), which provides compatibility with the most popular script loaders, to the output.\n* [Livereload](http://livereload.com/) to monitor your changes and update your browser instantly \n* Error message system\n* Notifications\n* Unit tests written with ES2015 get transpiled on the fly\n* Browser tests in the browser\n* Node \u003e= 5.x\n\n## Babel \u003e= 6.x design changes\n\nIf you migrate from `Babel \u003e= 5.x` to `Babel \u003e= 6.x`, your code will probably break because \nBabel now have killed the `CommonJS` default export behaviour. \n\nAs a workaround, replace `export default { … }` with  `module.exports = { … }`\n\n## Getting Started\n\nJust clone the repo and install the necessary node modules.\n\n```js\n$ git clone https://github.com/kflash/gulps.git gulps\n$ cd gulps\n$ npm install                   # Install Node modules listed in ./package.json\n$ npm webpack                   # Build a non-minified version of the library\n```\n\n## Workflow\n\n* `npm run packages` - List installed packages\n* `npm run package:purge` - Remove all dependencies\n* `npm run package:reinstall` - Reinstall all dependencies\n* `npm run package:check` - shows a list over dependencies with a higher version number then the current one - if any \n* `npm run package:upgrade` - Automaticly upgrade all devDependencies \u0026 dependencies, and update package.json\n* `npm run package:dev` - Automaticly upgrade all devDependencies and update package.json\n* `npm run package:prod` - Automaticly upgrade all dependencies and update package.json\n\n## Gulp tasks\n\n* `gulp dev` - Build task that generate compiled script\n* `gulp prod` - Build task that generate a minified script for production\n* `gulp clean` - Remove the `dist` folder and it's files\n* `gulp lint:source` - Lint the source\n* `gulp lint:test` - Lint the unit tests\n* `gulp test` - Runs unit tests\n* `gulp watch` - Run all unit tests \u0026 watch files for changes\n* `gulp coverage` - Generates a coverage report\n* `gulp browser` - Let you run unit tests in your browser.\n* `gulp gzip` - Gzip the compiled script\n* `gulp help` - Lists all available gulp tasks from your gulpfile.\n\n## Unit tests\n\nThis project uses Mocha to run your unit tests. By default all units tests runs on the server side. \n\nTo add a unit test, simply create `.js` file inside the `~/test/specs` folder, and Mocha and Chai will be available within your unit tests without the need to import them.\n\nTo run the tests in the project, just simply `gulp test`.\n\nTo keep watching the common test suites that you are working on, simply do `gulp watch`.\n\n## Browser tests\n\nTo run your unit tests in the browser, do `gulp browser`, and then open the `~/test/runner.html` in your browser.\n\n## Coveralls\n\nThis library is set up to integrate with Isparta, and will automaticly publish your coverage report if you have created an account for your repo at **coveralls.io**. You can also run `gulp coverage` to generate the coverage report in your CLI.\n\n## Linting\n\nThis boilerplate project uses ESLint and the [Airbnb styleguide](https://github.com/airbnb/javascript#ecmascript-6-styles) to lint your source. To change the rules, edit the .eslintrc file in the root directory, respectively.\n\n## Package management\n\nGulps has build-in some nice features to always make sure your dependency tree are up to date. \n\nTo check for the latest dependencies, simply run `npm run package:check`. \n\nIf you want to update your packages, you can simply do `npm run package:upgrade`.\n\n*Note!* Your `package.json` will be automatically updated so make sure you have saved your changes before running this.\n\nTo reinstall all packages, do `npm run package:reinstall`, and to remove all packages  `npm run package:purge`.\n\n## Pre-commit\n\nThis boilerplate uses a [pre-commit hook](https://www.npmjs.com/package/pre-commit) to ensure that your npm test (or other specified scripts) passes before you can commit your changes. This all conveniently configured in your package.json.\n\n## Installation\n\nEach time you clone the repo, use:\n\n```\nnpm install \n```\n\n## FAQ\n\n#### Is this boilerplate production ready?\nYes, for small applications. For a larger project, you'll need to customize the boilerplate after your own needs, but that is out of scope of this boilerplate.\n\n#### What's the browser compatibility?\n\nThis transpiler works best in IE9+, but you can support IE8 by limiting yourself to a subset of ES2015 features.\n\n#### How to set environment variables?\nYou can use Gulp for that. On the command line you can do `gulp --env='prod`. \nIn the gulp taks, you can use `gulp-utils`:  `.pipe(gutil.env.env === 'prod' ? minifySomething() : gutil.noop())`\n\n## License\nMIT © [KFlash](https://github.com/kflash)\n\n[trav_img]: https://api.travis-ci.org/Kflash/gulps.svg\n[trav_site]: https://travis-ci.org/Kflash/gulps.svg?branch=master\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjadbox%2Fgulps","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjadbox%2Fgulps","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjadbox%2Fgulps/lists"}