Skip to content

Set up a dev environment

jmacura edited this page Sep 9, 2019 · 5 revisions
  • Clone the repository with git clone https://github.com/hslayers/hslayers-ng.git into a folder of your choice. This will be your main working directory.

HSLayers-NG itself is just a library so in order to see your new features running, you must use HSLayers-NG in a project. You can create a project of your own from scratch, as described in Getting started, or clone an existing one – check the hslayers repositories.

Let's use the Foodie project as an example here:

  • git clone https://github.com/hslayers/project-foodie.git into some other folder on your computer.
  • Run npm install in the project's folder (project-foodie in this case). This will install all dependencies of the project into the node_modules (see https://docs.npmjs.com/cli/install for more detailed info).

Now the project uses the HSLayers-NG version which is available in npm, which is generally the last public release version. But we want it to use the HSLayers-NG version which we have cloned into our machine in the first step. We can achieve this by using symbolic links (or "symlinks").

  • Go back to your HSLayers-NG folder and run npm link.
  • Then navigate to the project's folder again and run npm link hslayers-ng.

Now the project will use the version of HSLayers-NG you have locally on your computer (see https://docs.npmjs.com/cli/link for more detailed info).

Clone this wiki locally