For a background on the project, please read this overview.
Flow works with:
There are binary distributions for each of these platforms and you can also build it from source on any of them as well.
Check out the installation instructions, and then how to get started.
Flow is written in OCaml (OCaml 4.09.1 is required).
brew install opam
sudo apt-get install opam
The following instructions expect
2.x.x. Should your package manager have installed a
1.x.x version, please refer to the opam docs to install a newer version manually.
# from within this git checkout opam switch create . --deps-only -y
eval $(opam env) make
This produces the
opam install -y js_of_ocaml.3.7.1 make js
To run the tests, first compile flow using
make. Then run
bash ./runtests.sh bin/flow
There is a
make test target that compiles and runs tests.
To run a subset of the tests you can pass a second argument to the
bash runtests.sh bin/flow class | grep -v 'SKIP'
Flow is MIT-licensed (LICENSE). The website and documentation are licensed under the Creative Commons Attribution 4.0 license (website/LICENSE-DOCUMENTATION).