Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 2.91 KB

CONFIGURATION.md

File metadata and controls

55 lines (41 loc) · 2.91 KB
Raw

Configuration

By default the Participatory Planning app takes the configuration from settings.json. You can override that by providing your own setting file as a query parameter:

https://esri.github.io/participatory-planning?settings=[url]

The settings parameter is expected to be a URL pointing to JSON file with the following structure:

{
  "planningArea": [
    [-8235924.058660398, 4968738.274357371],
    [-8235409.000644938, 4968717.325404106],
    [-8235333.439527529, 4968898.289607817],
    [-8235295.877979361, 4969109.891441089],
    [-8236134.357229519, 4969027.878528339],
    [-8236138.632189713, 4968850.261903069],
    [-8235919.081131686, 4968836.806196137]
  ],
  "planningAreaName": "Dumbo, Brooklyn NY",
  "webSceneId": "bceae470c9a04e5bb3ad42323c726c97"
}
  1. planningArea contains the Web Mercator coordinates of the planning area
  2. planningAreaName is the name of the area shown in the welcome screen of the app
  3. webSceneId must point to a Webscene, you can follow these steps to create your own:
    1. Create a Webscene in ArcGIS Online
    2. Add a SceneLayer with existing buildings in and around planning area.
    3. Capture a few slides with different perspectives of the planning area, they will show up at the upper navigation menu in the app

A simple way of providing your own settings file is using GitHub Gist and passing the Gist's URL (raw version) to the app. This is an example for a planning area in Zug, Switzerland:

https://esri.github.io/participatory-planning?settings=https://gist.githubusercontent.com/arnofiva/82f57a3cc2d99769f573898560f74e3f/raw/zug.pp.json

GitHub Deployment

The live version is deployed using GitHub pages. The gh-pages branch represents a separate git worktree directly pointing to the contents of the dist/ build output folder. The following commands update the gh-pages branch to the latest source code version:

git clone https://github.com/Esri/participatory-planning.git -b gh-pages dist

# OR

git clone [email protected]:Esri/participatory-planning.git -b gh-pages dist

npm run build
cd dist/
git add .
git commit -am 'Deploy latest version from master branch'
git push

Usually the changes become available shortly after at https://esri.github.io/participatory-planning. For more details check out the following tutorial.