https://github.com/naturalprogrammer/cleanflow

Draw your business logic!
https://github.com/naturalprogrammer/cleanflow

Last synced: 7 months ago
JSON representation

Draw your business logic!

• Host: GitHub
• URL: https://github.com/naturalprogrammer/cleanflow
• Owner: naturalprogrammer
• License: other
• Created: 2020-10-31T08:15:58.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-05-10T13:31:17.000Z (almost 4 years ago)
• Last Synced: 2025-07-06T22:05:10.207Z (10 months ago)
• Language: Java
• Size: 498 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# CleanFlow

![https://raw.githubusercontent.com/naturalprogrammer/cleanflow/1.3.0/src/test/resources/clean-flows/create-order.png](https://raw.githubusercontent.com/naturalprogrammer/cleanflow/1.3.0/src/test/resources/clean-flows/create-order.png)

"A picture is worth a thousand words" is very true in programming.

So, many of us use diagrams (e.g. activity or sequence diagrams) when coding complex business logic.

That not only helps to grasp the logic, but also puts all the stakeholders —

e.g. product managers, analysts, developers, reviewers and maintainers — on the same page.

 

But, maintaining code and diagram in parallel is hard. Not only it takes more effort,

but also the diagrams soon become out of sync. You can never rely on a

diagram — whenever you want to check something, you check the code.

  

CleanFlow solves this issue by letting you move business logic out into elegant diagrams.

When using CleanFlow, business logic is expressed and maintained in diagrams.

Code just contains simple methods (hooked into the nodes of the diagram).

So, no more cumbersome control-flows in your code!

Some key benefits of this approach:

* Business logic can be intuitively groomed via diagrams 

* Your code remains clean and straightforward. Bye-bye mind-boggling control flows!

* You no more have to preach [clean-coding](https://medium.com/mindorks/how-to-write-clean-code-lessons-learnt-from-the-clean-code-robert-c-martin-9ffc7aef870c)

to your developers — it becomes natural

* Reviewing code is fast and intuitive

* Understanding existing code it a breeze!

* Code won't deteriorate fast

## Documentation

CleanFlow is a JVM based library for expressing business logic in diagrams. The [getting started guide](https://github.com/naturalprogrammer/cleanflow/wiki/Getting-Started-With-CleanFlow)

covers all its features as of now. And of course, you can refer to the tests for more concrete examples.

## Requirements

* Java 8 or higher

## Help and support

* You can ask questions at [stack overflow](https://stackoverflow.com/), using `clean-flow` tag.