Boundless WebSDK

Javascript SDK based on React, OpenLayers 3 and Flux.

For the user interface, material-ui is used.

For example usage see the corresponding apps repository

For online docs see HTML

Generating docs

npm run docs

This depends on gitbook. The 3.1.0 release should be installed, verify with:

node_modules/.bin/gitbook ls

If not install it manually:

node_modules/.bin/gitbook fetch 3.1.0

The versions get installed at ~/.gitbook/versions/

The doc build also requires that ebook-convert from Calibre is installed and on the path.

Testing

npm test

npm run build

If you run into this error: Error: EMFILE, open 'sdk/node_modules/react/package.json' run the solution from here: andreypopp/react-app-express#1 (comment)

Code Style

All components (js/components) should have the top level class sdk-component, as well as a class matching their name (in all lowercase, dash-delimited).