Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 2.22 KB

README.md

File metadata and controls

61 lines (46 loc) · 2.22 KB
Raw

jQuery Plugin Boilerplate

jQuery plugin development boilerplate with gulp automation

Build Status npm version Bower version GitHub license Donate on Paypal

create-jquery-plugin

You can use create-jquery-plugin CLI tool to setup the jQuery plugin development setup. Just run

npx create-jquery-plugin

Articles

Requirements

  • jQuery (supports jQuery 1.9+, jQuery 2+ and jQuery 3+)

Installation and usage

NPM

npm install jquery-plugin-boilerplate

Yarn

yarn add jquery-plugin-boilerplate

Download

Download from GitHub

How to use

  • Clone or download this repository.
  • Run npm start on the directory.
  • It will open the project on browser with hot loading enbaled with Browserify.
  • Start wrting your code on src directory.

More details

  • Build files will be generated on dist directory automatically.
  • You can change example directory for examples of your plugin.
  • test directory contains test scripts. It uses Jasmine and Karma.

License

MIT License

Contribute

If you like the project please support with your contribution.

Donate on Paypal

Thank you and Happy Coding :)