Skip to content

Commit

Permalink
BB-3262: Initial commit. Batch processing framework.
Browse files Browse the repository at this point in the history
  • Loading branch information
Philip Downer committed Nov 12, 2018
0 parents commit 38cdc9c
Show file tree
Hide file tree
Showing 2,191 changed files with 171,499 additions and 0 deletions.
Empty file added .gitignore
Empty file.
1 change: 1 addition & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
https://www.gnu.org/licenses/gpl-3.0.html
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# WordPress Batch Processing

Provides a framework to handle large data processing jobs by breaking it into smaller chunks and running each job individually via AJAX requests.

## Installation

The recommended method of installation is via [Composer](https://getcomposer.org/).

### Composer
For more information on using Composer to manage WordPress plugins [read this guide](https://deliciousbrains.com/using-composer-manage-wordpress-themes-plugins/).

#### Add the repository to composer.json

1. In the `extra` array ensure you have:

```js
"installer-paths": {
"content/plugins/{$name}/": ["type:wordpress-plugin"]
}
```

Be sure that the installer path reflects your WordPress plugin directory.


2. In the `repositories` array of composer.json, add the following

```js
{
"type": "git",
"url": "git@github.com:RamseyInHouse/wp-ramsey-batch.git"
}
```

3. In the `require` object add:

```js
"RamseyInHouse/wp-ramsey-batch": "^1.0"
```
If you'd like a different version of the plugin, check the [Releases](https://github.com/RamseyInHouse/wp-ramsey-batch/releases) section of Github. This plugin adheres to [semantic versioning guidelines](https://getcomposer.org/doc/articles/versions.md).

4. Run the `composer install` command.

### Download and Install

You can download the plugin files here and add them to the `plugins` directory of your WordPress installation. [Follow the directions here](https://codex.wordpress.org/Managing_Plugins#Manual_Plugin_Installation_by_FTP).
35 changes: 35 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"name": "RamseyInHouse/wp-ramsey-batch",
"description": "Perform batch jobs inside of WordPress.",
"type": "wordpress-plugin",
"license": "GPL v3",
"version": "1.0.0",
"authors": [
{
"name": "Philip Downer",
"email": "philip.downer@daveramsey.com",
"homepage": "http://philipdowner.com"
},
{
"name": "Alex MacArthur",
"email": "alex.macarthur@daveramsey.com",
"homepage": "https://macarthur.me"
}
],
"require-dev": {
"phpunit/phpunit": "^7.3",
"mockery/mockery": "^1.1"
},
"autoload": {
"psr-4": {"RamseySolutions\\RamseyBatch\\": "src/"}
},
"autoload-dev": {
"psr-4": {
"RamseyBatchTests\\": "tests/"
}
},
"require": {
"php": ">=7.2",
"composer/installers": "^1.0.7"
}
}
Loading

0 comments on commit 38cdc9c

Please sign in to comment.