Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/techlab/jquery-plugin-boilerplate

jQuery plugin development boilerplate with gulp automation
https://github.com/techlab/jquery-plugin-boilerplate

browserify create-jquery-plugin gulp gulp-automation jasmine-tests jquery jquery-gulp jquery-plugin-boilerplate karma-jasmine travis-ci

Last synced: about 1 month ago
JSON representation

jQuery plugin development boilerplate with gulp automation

Awesome Lists containing this project

README

        

# jQuery Plugin Boilerplate
#### jQuery plugin development boilerplate with gulp automation

[![Build Status](https://travis-ci.org/techlab/jquery-plugin-boilerplate.svg?branch=master)](https://travis-ci.org/techlab/jquery-plugin-boilerplate)
[![npm version](https://badge.fury.io/js/jquery-plugin-boilerplate.svg)](https://badge.fury.io/js/jquery-plugin-boilerplate)
[![Bower version](https://badge.fury.io/bo/jquery-plugin-boilerplate.svg)](https://badge.fury.io/bo/jquery-plugin-boilerplate)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/techlab/jquery-plugin-boilerplate/master/LICENSE)
[![Donate on Paypal](https://img.shields.io/badge/PayPal-dipuraj-blue.svg)](https://www.paypal.me/dipuraj)

create-jquery-plugin
-----
You can use [create-jquery-plugin](https://www.npmjs.com/package/create-jquery-plugin) CLI tool to setup the jQuery plugin development setup. Just run
```bash
npx create-jquery-plugin

```

Articles
-----
+ [jQuery plugin development with Gulp automation](https://medium.com/@dipuraj/jquery-plugin-development-with-gulp-automation-ae5d2c180f85)

Requirements
-----
+ [jQuery](http://jquery.com/) (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](https://github.com/techlab/jquery-plugin-boilerplate/archive/master.zip)

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](http://browserify.org/).
- 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](https://jasmine.github.io/) and [Karma](https://karma-runner.github.io/).

License
----
[MIT License](https://github.com/techlab/jquery-plugin-boilerplate/blob/master/LICENSE)

Contribute
----
If you like the project please support with your contribution.

[Donate on Paypal](https://www.paypal.me/dipuraj)

Thank you and Happy Coding :)