Home

Awesome

Flowmaker

Flowmaker is an VSCode extension used to generate a flowchart in SVG format of javascript code to demonstrate Code flow scheme from different level of conduct.

Flowmaker features

onBrowser demo

Note: For only using the onEditor SVG generation follow the <a href="https://github.com/aryaminus/flowmaker/tree/livepreview" target="_blank">livepreview</a> branch code.

For showing in both Browser and Editor follow the <a href="https://github.com/aryaminus/flowmaker/tree/onBrowser" target="_blank">onBrowser</a> branch code.

Instructions

Installation

From VS Code Market Install Flowmaker: Install Flowmaker extension:

Launch VS Code Quick Open (Ctrl+P), paste the following command:
ext install speks.flowmaker

Then,

Open any .js file
hit Fn+f1 or F1
choose Flowmake onEditor or Flowmake onBrowser

or, Clone the source locally:

$ git clone https://github.com/aryaminus/flowmaker
$ cd flowmaker
$ npm install

and, Start the application in development mode

hit Ctrl+f5
hit Fn+f1 or F1
choose Flowmaker: Save or Flowmaker: Preview

Packages:

  1. <a href="https://github.com/Bogdan-Lyashenko/js-code-to-svg-flowchart" target="_blank">js2flowchart</a>
  2. <a href="https://github.com/GramParallelo/atom-js-code-to-svg-to-preview" target="_blank">atom-js-code-to-svg-to-preview</a>

Features

onEditor demo

TODO:


Contributing

  1. Fork it (https://github.com/aryaminus/flowmaker/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request

Enjoy!