https://github.com/alexanderankin/create-react-jquery-plugin
CLI for bootstrapping a React-based jQuery plugin
https://github.com/alexanderankin/create-react-jquery-plugin
Last synced: 2 months ago
JSON representation
CLI for bootstrapping a React-based jQuery plugin
- Host: GitHub
- URL: https://github.com/alexanderankin/create-react-jquery-plugin
- Owner: alexanderankin
- Created: 2020-01-21T08:36:33.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-19T08:54:24.000Z (almost 5 years ago)
- Last Synced: 2025-04-01T03:34:23.545Z (2 months ago)
- Language: JavaScript
- Size: 160 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Create React JQuery Plugin
Easily set up a project to produce a jQuery plugin implemented with the React
framework. The goal is to create a component, which can be distributed
separately from an app or web page, but rather can be added to any page with
jQuery already installed.
## Changelog
`v0.0.1`
* It works
`v0.0.2`
* Comments in the package.json
* React Redux and Promise, thunk, and logger middleware
`v0.0.3`
* do not watch `/node_modules/`
## Usage:
```
yarn create react-jquery-plugin my-plugin
```
or one of:
```
npx create-react-jquery-plugin my-plugin
npm init react-jquery-plugin my-plugin
```
## Features
TBD
## How It Works
It guesses some things about the project and complains if the src folder or
any of the files to be added are already there. Then it guesses some things
about the git configuration (to update the package.json author and repository
fields), copies everything from the template, and adds a bunch of dependencies
to the package.json so you can install them with yarn install or npm install.
## Dependencies
The template was created with
```
yarn add -D dotenv webpack webpack-cli mini-css-extract-plugin @babel/cli \
@babel/core @babel/plugin-proposal-class-properties @babel/preset-env \
@babel/preset-react babel-loader css-loader react react-dom prop-types \
webpack-dev-server
```
## Shoutouts
[@swizec](https://twitter.com/swizec) for the blog post which inspired this
tool: [React components as jQuery plugins](
https://swizec.com/blog/using-react-in-the-real-world/swizec/6710)