Laravel Simple Workflow

A standard workflow system ready to use in 3 steps! Install > Configure > Use
Explore the docs »

Report Bug · Request Feature

Table of contents

• Table of contents
• About the project
  • Built with
• Getting started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License
• Contact

About the project

You can find several complex workflow management systems, or even very easy systems that are incomplete. This project is a generic abstraction with the features that any project that must implement a workflow system must have.

Why choose this project among others?

• Quick installation, 2 commands only!!
• Two commands that facilitate the following tasks:
  • Implementation of the workflow system on any model
  • And, the configuration of workflow transitions
• Pre-defined REST APIs allowing to interact with the different models of the workflow system (data recovery, insertion, update and deletion)
• Paging utilities, adding specs to the model
• Fully configured with a configuration file
• ... and many other benefits....

Built with

This project is carried out mainly with Laravel 5.8.*

Getting started

This section will guide you step by step to install configure the workflow system on your project

Prerequisites

Before you start using this workflow system, you need to have a Laravel 5.8.* project installed.
Please refer to the official Laravel documentation for more information.

Installation

First of all, install the package using the composer command:

  composer require heloufir/simple-workflow

After that you need to publish the package, to have access to it's configuration file:

  php artisan vendor:publish --provider="Heloufir\SimpleWorkflow\SimpleWorkflowServiceProvider"

That's it, your are ready to use it. You see! I told you 2 commands only!!

Usage

There are several features provided by this workflow system, please refer to the wiki of this repository for more information on how to use this system and get an idea about it's different features.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the project
2. Create your feature branch

   git checkout -b feature/AmazingFeature

3. Commit your changes

   git commit -m 'Add some AmazingFeature'

4. Push to the branch

   git push origin feature/AmazingFeature

5. Open a pull request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

EL OUFIR Hatim eloufirhatim@gmail.com
Project Link: https://github.com/heloufir/simple-workflow