5. Developing with Escher¶
5.1. Using the static javascript files¶
You can include the compiled Escher javascript file in any html document. The only dependencies are d3.js, and Twitter Bootstrap if you are using the option menu=’all’. These files can be found in escher/lib.
For an example of the boilerplate code that is required to begin developing with Escher, have a look at the escher-demo repository.
5.2. Running the local server¶
You can run your own local server if you want to modify the Escher code, or use Escher offline. To get started, install the Python package and run from any directory by calling:
python -m escher.server
This starts a server at localhost:7778. You can also choose another port:
python -m escher.server --port=8005
5.3. Building and testing Escher¶
Build the minified and non-minified javascript files:
python setup.py buildjs
Test Python and start Jasmine for JavaScript testing:
python setup.py test
Build the static website:
python setup.py buildgh
Clear static website files:
python setup.py clean