react component ui for map builder
Make sure you have the latest Stable or LTS version of Node.js installed.
git clone git@github.com:ONSdigital/dp-map-builder-ui.git- Run
npm install - Start the dev server using
npm start - Open http://localhost:8080
npm start- start the dev servernpm clean- delete the dist foldernpm run production- create a production ready build indistfoldernpm run lint- execute an eslint checknpm test- run all testsnpm run test:watch- run all tests in watch modenpm run coverage- generate code coverage report in thecoveragefolder
- The map builder is only as good as the topology files it offers. These are obtained via the github api from github.com/ONSvisual/topojson_boundaries
- The map builder calls the github api without authentication to retrieve the list of topology files (every time it starts - so once for every map). The api has a rate limit of 60 requests/hour unless you're authenticated: developer.github.com/v3/#rate-limiting. You may hit this limit if multiple people are creating maps at the same time.
- There are a lot of options in the map-renderer service that this builder hides away from the user and hard-codes.
- the position of the legends. These are hard-coded at the top and right of the map.
- width: The map width at which the visibility of the legends switches from horizontal to vertical. 400.
- min_width & max_width: The minimum and maximum sizes of the map - it is responsive within these limits. 300 - 500.
- The ID and Name properties used in the topology files. These are AREACD and AREANM respectively - and this holds true for all topologies currently in the repository.
- The colour options for the map are those published at colorbrewer2.org, filtered to remove those that are not colour-blind safe. They have been renamed to give them slightly more descriptive names in the drop down.