Setting up development environment
You will obviously start by forking the OpenLayers repository.
The Travis CI hook is enabled on the Github repository. This means every pull request is run through a full test suite to ensure it compiles and passes the tests. Failing pull requests will not be merged.
The minimum requirements are:
- Node.js (version 8 and above)
node should be in your
To install the Node.js dependencies run
$ npm install
To run the examples you first need to start the dev server:
$ npm run serve-examples
Then, load http://localhost:5000/ in your browser.
To run the tests once:
$ npm test
To run the tests continuously during development:
$ npm run karma
Adding functionality often implies adding one or several examples. This section provides explanations related to adding examples.
The examples are located in the
examples directory. Adding a new example
implies creating two or three files in this directory, an
.html file, a
file, and, optionally, a
You can use
simple.html as templates for new examples.