prakhar-goel / flow

Adds static typing to JavaScript to improve developer productivity and code quality.

Flow

Flow is a static typechecker for JavaScript. To find out more about Flow, check out flowtype.org.

For a background on the project, please read our launch blog post.

Requirements

Flow works with:

• Mac OS X
• Linux (64-bit) There are binary distributions for Mac OS X and many variants of Linux; you can also build it from source on almost any 64-bit Linux variant.

Building Flow

Flow is written in OCaml (OCaml 4.x is required) and (on Linux) requires libelf. You can install OCaml on Mac OS X and Linux by following the instructions at ocaml.org.

Once you have these dependencies, building Flow just requires running

make

This produces a bin folder containing the flow binary.

Installing Flow

Flow is simple to install: all you need is the flow binary on your PATH and you're good to go.

Documentation

Check out http://flowtype.org for documentation and examples.

Join the Flow community

• Website: http://flowtype.org/
• irc: #flowtype on Freenode
• Twitter: @flowtype and #flowtype to keep up with the latest Flow news.

License

Flow is BSD-licensed. We also provide an additional patent grant.