theshopworks / task-master
Run a set of tasks synchronously.
Requires
- php: ^7.1.3
Requires (Dev)
- mockery/mockery: dev-master@dev
- phpunit/phpunit: ^7.0
- theshopworks/git-review: ^0.13
This package is not auto-updated.
Last update: 2023-05-31 12:43:00 UTC
README
Process several console tasks in a sequential fashion and then receive results of all tasks in a single place.
Please visit theshopworks.gitlab.io/task-master for full documentation.
Installation
Add the task-master
package to your composer.json
file.
{
"require": {
"theshopworks/task-master": "^0.1"
}
}
Or via the command line in the root of your Laravel installation.
$ composer require "theshopworks/task-master:^0.1"
Usage
vendor/bin/task-master
Commands
Information relating to any commands for this project, can be found on the docs site.
Code Style
This project follows the following code style guidelines:
- PSR-2 & PSR-4 coding style guidelines.
- Some chosen PHP-CS-Fixer rules.
$ php vendor/bin/php-cs-fixer fix
Testing
$ php vendor/bin/phpunit
Documentation
Documentation for this project can be found in the docs/
folder. We use a static site generator Hexo, to generate our documentation.
The documentation is licensed under a Creative Commons Attribution 4.0 Generic License. It is attributed to Tommy Chen, and their original version can be found here. Please see, the LICENSE
The docs are automatically deployed to https://theshopworks.gitlab.io/task-master, on every merge of master
.
To build the docs locally, you will need to do the following:
REQUIREMENT: You will need to install Yarn, before you can genarate the docs.
cd docs/
yarn install
./node_modules/.bin/hexo server
To generate the /public
files, you can also use ./node_modules/.bin/hexo generate
.
Contributing
Please see CONTRIBUTING for details.
License
The MIT License (MIT). Please see License File for more information.