dairyisscary / flowstick

A fast and fun XPDL editor written in Elm!
MIT License
3 stars 1 forks source link

No README #1

Open vizJS opened 7 years ago

vizJS commented 7 years ago

Hello Eric,

This looks like a very cool project idea. I'd love some brief instruction on what it is meant to do, what it does do, and how to make it do anything, if it currently does anything.

As it is, I've built and run it, in a few different modes, and just get a view of a blank white empty canvas. I see multiple commits, so.... What am I missing?

Any chance you could describe a brief example use, if even a trivial one, in a README.md file?

Thanks in advance!

~ ~ Jonathan

dairyisscary commented 7 years ago

Hi there Jonathan!

Flowstick is an editor for the XPDL file type, which is a serialization format of BPMN. https://en.wikipedia.org/wiki/XPDL https://en.wikipedia.org/wiki/Business_Process_Model_and_Notation

If you're not familiar with these things, basically, its a way to describe a program visually. So literally there are little boxes on the screen (akin to statements in a programming language) and transitions/arrows between these statements describing the flow of the program. Basically, flowstick is an an electron app in written in Elm for editing these visual programs. Think like drag and drop, drawing new lines between boxes, almost like a very constrained sketch program.

The company I work for uses XPDL internally for some things but the editor we use is pretty lackluster in a variety of ways, so last year I was seeing how hard it would be to write it from scratch. I had a few features written like read, drag and drop and transition drawing, but I got busy with some other stuff and kind of forgot about it.

Just coincidentally, there has been a resurgence of interest in this effort at the company and some other engineers are interested in experimenting with it again. Regardless, my plan is in the next week to get this project on its feet again, upgrade the dependencies, get like elm-test/quickcheck up and running so that other developers can get to using it too. I'll do my best to add a README and some sample data so that there's an XPDL you can actually open with the editor source code haha.