fgpv-vpgf

Federal Geospatial Platform Visualiser / Visualisateur pour la Plateforme géospatiale fédérale

Getting Started

Requirements:

• NodeJS

Running a local build:

0. Checkout the repo
1. Switch to the develop branch (master is for stable, released code)
2. Run npm install to install dependencies
3. Run npm run serve to build and launch a dev server

We use a fork and pull model for contributions, see our contributing guidelines for more details.

Interactive Schema Documentation

Generating Local Builds

• npm run build

  Builds development code and places it in the build directory. Performs eslint, SASS -> CSS, and babel compilation

• npm run build -- --env.prod

  Builds production code and places it in the build directory. Performs same steps as development builds, but also places a zipped file of the build in the dist directory.

Serving Development Code

• npm run serve

  Serves the development code. Reloads on file change.

• npm run serve -- --env.prod

  Serves the production code. Reloads on file change.

Inspecting Bundle Dependencies

Run npm run build -- --env.inspect

When complete, navigate to http://127.0.0.1:8888 in chrome.

You can also use two external tools with the build/stats.json file - http://webpack.github.io/analyse - https://chrisbateman.github.io/webpack-visualizer/

Optional Flags

To run these flags, prefix with -- then --env. as in npm run serve -- --env.prod where prod is a flag.

• geoLocal Replaces geoApi from npm node_module with a local geoApi repo folder located by ../geoApi

• geoLocal="path/to/geoApi" Same as no argument geoLocal but uses the provided path to local folder

• useMap Creates full independent source maps files for development code only. Build time will increase.