{"id":13395004,"url":"https://github.com/jquery-boilerplate/jquery-boilerplate","last_synced_at":"2025-05-15T01:04:24.958Z","repository":{"id":54962124,"uuid":"1760686","full_name":"jquery-boilerplate/jquery-boilerplate","owner":"jquery-boilerplate","description":"A jump-start for jQuery plugins development","archived":false,"fork":false,"pushed_at":"2020-09-30T19:32:35.000Z","size":2227,"stargazers_count":2524,"open_issues_count":12,"forks_count":515,"subscribers_count":97,"default_branch":"master","last_synced_at":"2024-10-29T15:27:10.445Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://jqueryboilerplate.com","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/jquery-boilerplate.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-05-17T12:49:29.000Z","updated_at":"2024-10-16T05:01:18.000Z","dependencies_parsed_at":"2022-08-14T07:31:05.833Z","dependency_job_id":null,"html_url":"https://github.com/jquery-boilerplate/jquery-boilerplate","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jquery-boilerplate%2Fjquery-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jquery-boilerplate%2Fjquery-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jquery-boilerplate%2Fjquery-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jquery-boilerplate%2Fjquery-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jquery-boilerplate","download_url":"https://codeload.github.com/jquery-boilerplate/jquery-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248785731,"owners_count":21161341,"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-07-30T17:01:38.865Z","updated_at":"2025-04-13T21:30:20.613Z","avatar_url":"https://github.com/jquery-boilerplate.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Animation"],"sub_categories":["Miscellaneous Plugins"],"readme":"# jQuery Boilerplate [![Build Status](https://secure.travis-ci.org/jquery-boilerplate/jquery-boilerplate.svg?branch=master)](https://travis-ci.org/jquery-boilerplate/jquery-boilerplate) ![Bower Version](https://badge.fury.io/bo/jquery-boilerplate.svg)\n\n### A jump-start for jQuery plugins development\n\nSo, you've tried your hand at writing jQuery plugins and you're comfortable putting together something that probably works. Awesome! Thing is, you think there might be better ways you could be writing them - you've seen them done a number of different ways in the wild, but aren't really sure what the differences between these patterns are or how to get started with them.\n\nThis project won't seek to provide a perfect solution to every possible pattern, but will attempt to cover a simple template for beginners and above. By using a basic defaults object, simple constructor for assigning the element to work with and extending options with defaults and a lightweight wrapper around the constructor to avoid issues with multiple instantiations.\n\n## Usage\n\n1. Include jQuery:\n\n\t```html\n\t\u003cscript src=\"http://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js\"\u003e\u003c/script\u003e\n\t```\n\n2. Include plugin's code:\n\n\t```html\n\t\u003cscript src=\"dist/jquery.boilerplate.min.js\"\u003e\u003c/script\u003e\n\t```\n\n3. Call the plugin:\n\n\t```javascript\n\t$(\"#element\").defaultPluginName({\n\t\tpropertyName: \"a custom value\"\n\t});\n\t```\n\n## Structure\n\nThe basic structure of the project is given in the following way:\n\n```\n├── demo/\n│   └── index.html\n├── dist/\n│   ├── jquery.boilerplate.js\n│   └── jquery.boilerplate.min.js\n├── src/\n│   ├── jquery.boilerplate.coffee\n│   └── jquery.boilerplate.js\n├── .editorconfig\n├── .gitignore\n├── .jshintrc\n├── .travis.yml\n├── Gruntfile.js\n└── package.json\n```\n\n#### [demo/](https://github.com/jquery-boilerplate/boilerplate/tree/master/demo)\n\nContains a simple HTML file to demonstrate your plugin.\n\n#### [dist/](https://github.com/jquery-boilerplate/boilerplate/tree/master/dist)\n\nThis is where the generated files are stored once Grunt runs.\n\n#### [src/](https://github.com/jquery-boilerplate/boilerplate/tree/master/src)\n\nContains the files responsible for your plugin, you can choose between JavaScript or CoffeeScript.\n\n#### [.editorconfig](https://github.com/jquery-boilerplate/boilerplate/tree/master/.editorconfig)\n\nThis file is for unifying the coding style for different editors and IDEs.\n\n\u003e Check [editorconfig.org](http://editorconfig.org) if you haven't heard about this project yet.\n\n#### [.gitignore](https://github.com/jquery-boilerplate/boilerplate/tree/master/.gitignore)\n\nList of files that we don't want Git to track.\n\n\u003e Check this [Git Ignoring Files Guide](https://help.github.com/articles/ignoring-files) for more details.\n\n#### [.jshintrc](https://github.com/jquery-boilerplate/boilerplate/tree/master/.jshintrc)\n\nList of rules used by JSHint to detect errors and potential problems in JavaScript.\n\n\u003e Check [jshint.com](http://jshint.com/about/) if you haven't heard about this project yet.\n\n#### [.travis.yml](https://github.com/jquery-boilerplate/boilerplate/tree/master/.travis.yml)\n\nDefinitions for continous integration using Travis.\n\n\u003e Check [travis-ci.org](http://about.travis-ci.org/) if you haven't heard about this project yet.\n\n#### [Gruntfile.js](https://github.com/jquery-boilerplate/boilerplate/tree/master/Gruntfile.js)\n\nContains all automated tasks using Grunt.\n\n\u003e Check [gruntjs.com](http://gruntjs.com) if you haven't heard about this project yet.\n\n#### [package.json](https://github.com/jquery-boilerplate/boilerplate/tree/master/package.json)\n\nSpecify all dependencies loaded via Node.JS.\n\n\u003e Check [NPM](https://npmjs.org/doc/json.html) for more details.\n\n## Guides\n\n#### How did we get here?\n\nHave you got in this repo and still not sure about using this boilerplate?\n\nWell, extending jQuery with plugins and methods is very powerful and can save you and your peers a lot of development time by abstracting your most clever functions into plugins.\n\n[This awesome guide](https://github.com/jquery-boilerplate/boilerplate/wiki/How-did-we-get-here%3F), adapted from [jQuery Plugins/Authoring](http://docs.jquery.com/Plugins/Authoring), will outline the basics, best practices, and common pitfalls to watch out for as you begin writing your plugin.\n\n#### How to publish plugins?\n\nAlso, check our guide on [How to publish a plugin in jQuery Plugin Registry](https://github.com/jquery-boilerplate/boilerplate/wiki/How-to-publish-a-plugin-in-jQuery-Plugin-Registry\n)!\n\n**Note:** The jQuery Plugin Registry is in read-only mode. New plugin releases will not be processed.\njQuery recommends moving to [npm](https://www.npmjs.com/), using [\"jquery-plugin\"](https://www.npmjs.com/browse/keyword/jquery-plugin) as the keyword in your package.json. See [how to publish into npm registry](https://gist.github.com/coolaj86/1318304).\n\n## Team\n\njQuery Boilerplate was made with love by these guys and a bunch of awesome [contributors](https://github.com/jquery-boilerplate/boilerplate/graphs/contributors).\n\n[![Zeno Rocha](http://gravatar.com/avatar/e190023b66e2b8aa73a842b106920c93?s=70)](http://zenorocha.com) | [![Addy Osmani](http://gravatar.com/avatar/96270e4c3e5e9806cf7245475c00b275?s=70)](http://addyosmani.com) | [![Helder Santana](http://gravatar.com/avatar/63fb620ee7d14fc91030d4349d189b3e?s=70)](http://heldr.com)\n--- | --- | --- | --- | --- | --- | ---\n[Zeno Rocha](http://zenorocha.com) | [Addy Osmani](http://addyosmani.com) | [Helder Santana](http://heldr.com)\n\n## Contributing\n\nCheck [CONTRIBUTING.md](https://github.com/jquery-boilerplate/boilerplate/blob/master/CONTRIBUTING.md) for more information.\n\n## History\n\nCheck [Releases](https://github.com/jquery-boilerplate/jquery-boilerplate/releases) for detailed changelog.\n\n## License\n\n[MIT License](http://zenorocha.mit-license.org/) © Zeno Rocha\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjquery-boilerplate%2Fjquery-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjquery-boilerplate%2Fjquery-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjquery-boilerplate%2Fjquery-boilerplate/lists"}