JAWE is a powerful and extensible Workflow Engine designed to manage workflows as Directed Acyclic Graphs (DAGs). It allows for the seamless integration of custom business logic through plugins, making it ideal for building complex workflows efficiently.
- Flexible Workflow Templates: Define workflows with steps and transitions.
- Plugin-Based Architecture: Extend functionality with custom plugins.
- Dynamic Inputs/Outputs: Handle both static and dynamic data flows.
- Multiple Triggers: Initiate workflows via HTTP endpoints, cron jobs, or custom triggers.
To use JAWE, ensure you have the following installed:
- Node.js (>= 20.x)
- npm (>= 8.x)
- Docker
Clone the repository and install dependencies:
git clone https://github.com/your-repo/jawe.git
cd jawe
npm installStart the development server:
npm run devThis command starts the JAWE engine and makes it ready for workflow execution.
To run the project, you need to have the Docker container with the database already up and running. Alternatively, you can use the following command to start everything together:
npm run startThis command installs the dependencies, starts the Docker containers using docker-compose, and runs the development server.
The Import/Export feature in JAWE enables users to serialize and deserialize workflow templates, allowing for easy saving, sharing, and restoration of workflows, including all configurations, triggers, steps, and connections.
If you want to start with a sample workflow in a matter of seconds, you can follow the import/export guide and import the getting-started sample
Guide to Import and Export a Workflow
To run the unit tests and ensure everything works as expected:
npm run testPlugins encapsulate the business logic of a workflow step. To create a new plugin, follow the guide linked below:
We welcome contributions to JAWE! To contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature-name). - Make your changes and commit them (
git commit -m 'Add feature'). - Push your branch (
git push origin feature-name). - Open a pull request.
Please adhere to the coding standards and include tests for your changes.
backend/: Contains the core engine logic, the plugins and REST APIs to communicate with the frontend.frontend/: Houses the frontend with the editordocs/: Documentation files.
JAWE is licensed under the MIT License. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.