mapmap-examples
July 3, 2016 ยท View on GitHub
Collection of examples for the mapmap.js API
The examples are available online!
Running the examples locally
There is a minimal Python web server included that can be used to launch the examples. Run serve.bat on windows or
python server.py 8089
on your platform and point your browser to http://localhost:8089
Included examples
| Folder | Description |
|---|---|
| tutorial | Tutorials, serving as a starting point if you want to learn mapmap.js |
| test | Small, uncategorized examples and in-browser tests for various features. |
| minard | A simplified version of Minard's Map using mapmap.js |
Other folders:
| Folder | Description |
|---|---|
| data | Common data files used in the examples |
| lib | 3rd party JavaScript libraries used in the examples |
Developing mapmap
If you want to use this repository as a base to test out changes for mapmap.js, the best setup is to link your local checkout of the mapmap.js repository as a npm package using npm link.
To do this, in the directory of your mapmap.js repository, run
npm link
Then, in the directory of this repository (mapmap-examples), run this sequence of commands:
npm link mapmap
npm install
You can then edit the mapmap.js source code in the original repository and have the changes reflected here. To automatically trigger a rebuild of mapmap.js with every change, run
npm run watch
and keep it running as long as you develop.
More information
For more information on mapmap.js, see the mapmap.js Programming Guide, API Documentation or wiki.
If you have questions or suggestions for improvements, contact me on Twitter or by Email.