public-information-map-template-js

This is a fully configurable public facing mapping application that highlights areas through authoritative data feeds and social content, allowing the public to tell a story.

View it live

The template can be configured using the following options:

Map: Choose the web map to use in your application.
Interactive: Map Notes: An author can describe areas on the map using a map notes layer.
Responsive: A side drawer is shown when its size can be accommodated. The responsive drawer can be toggled on or off by the user and allows the application to be embedded into blogs and websites.
Navigation: Home and Locate buttons add ease of map navigation.
Content: Choose to display geo-located content from Flickr, Twitter, Instagram or Webcams.travel.
Summary: Briefly describe your application in the "Area" panel.
Keywords: Use query keywords to search on Flickr or Twitter.
Search: Enable Searching for addresses and places.
Share: Share this application through Twitter, Facebook, Google+ or generate HTML for embedding in a blog or website.
Basemap: Enable toggling between two Esri basemaps.
Layers: Toggle visibility of layers.
Legend: Display a legend.
Bookmarks: Webmap bookmarks can be used to navigate the map.
About: Display information about the application. The dialog can also be set to open on startup.
Access and Use Constraints: Display Access and Use Constraints for the webmap in a pop-up dialog when the map opens.

Instructions

Download and unzip the .zip file or clone the repository.
Web-enable the directory.
Access the .html page.
Start writing your template!

New to Github? Get started here.

Deploying

To deploy this application, download the template from Portal/ArcGIS Online and unzip it.
Copy the unzipped folder containing the web app template files, such as index.html, to your web server. You can rename the folder to change the URL through which users will access the application. By default the URL to the app will be http://<Your Web Server>/<app folder name>/index.html
Change the sharing host, found in defaults.js inside the config folder for the application, to the sharing URL for ArcGIS Online or Portal. For ArcGIS Online users, keep the default value of www.arcgis.com or specify the name of your organization.

ArcGIS Online Example: "sharinghost": "https://" + “<your organization name>.maps.arcgis.com
Portal Example where arcgis is the name of the Web Adaptor: "sharinghost": "https://" + "webadaptor.domain.com/arcgis"

If you are using Portal or a local install of the ArcGIS API for JavaScript, change all references to the ArcGIS API for JavaScript in index.html to refer to your local copy of the API. Search for the references containing "https://js.arcgis.com/3.35" and replace this portion of the reference with the url to your local install.

For example: "https://webadaptor.domain.com/arcgis/jsapi/jsapi" where arcgis is the name of your Web Adaptor.

Copy a map or group ID from Portal/ArcGIS Online and replace the default web map ID in the application’s index.html page. You can now run the application on your web server or customize the application further.

Note: If your application edits features in a feature service, contains secure services or web maps that aren't shared publicly, or generate requests that exceed 200 characters, you may need to set up and use a proxy page. Common situations where you may exceed the URL length are using complex polygons as input to a task or specifying a spatial reference using well-known text (WKT). For details on installing and configuring a proxy page see Using the proxy. If you do not have an Internet connection, you will need to access and deploy the ArcGIS API for JavaScript documentation from developers.arcgis.com.

Social Media Deployment

In order to use some of the social media feeds on a different server, you'll need to get your own user keys for your app and in some cases deploy a proxy in order to correctly connect.

You'll need to point these values to the sign in URL and query URL of the proxy.

Flickr Configuration

You'll need to obtain your own unique key from the Flickr API

Then, enter it in the config as flickr_key.

Instagram Configuration

You'll need to obtain your own unique Instagram client ID key from the Instagram API

Make sure to enter all valid redirect URI's in the instagram security panel so that your app can connect to their servers.

Then, enter it in the config as instagramClientId.

Twitter Configuration

Since the Twitter search API doesn't support user authentication using oAuth2, we need to use oAuth 1.1 which requires the keys to be stored server side for security. Therefore, we need to create a Twitter proxy that will keep the keys secret and allow us to query information through the Twitter Search API.

Proxies:

Once the proxy is setup, you'll need to point the user config to the location of the signin url and twitter url.

The config values are:

twitterUrl
twitterSigninUrl

Then, you'll need to get an API key from the Twitter API. Once you have that, plug the details of it into the proxy configuration.

Webcams.travel Configuration

You'll need to obtain your own unique Webcams.travel key from the Webcams.travel API

Then, enter it in the config as webcams_key.

YouTube Configuration

You'll need to obtain your own unique API key from the YouTube API

First, you'll have to enable the "YouTube Data API v3" so that it can be used by your application.

You'll want to create an API use key for "YouTube Data API v3" and set credentials on it to restrict traffic from only the domain where your application will be hosted. For example, we use ".arcgis.com/".

Then, enter it in the config as youtube_key.

Requirements

Notepad or HTML editor
A little background with Javascript
Experience with the ArcGIS Javascript API would help.

Webfonts

This application uses a custom webfont created on Fontello. If you're hosting this application on your own server, make sure that it's configured to host the webfont files with the correct mime types. Some servers require a mime type set for these files to be able to serve them correctly. See the following URLs for more information. There is a zip archive of the webfont with it's fontello config in the "resources" folder in this repository.

Resources

Issues

Find a bug or want to request a new feature? Please let us know by submitting an issue.

Contributing

Anyone and everyone is welcome to contribute. :)

Licensing

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A copy of the license is available in the repository's license.txt file.

douglaseggleton / public-information-map-template-js Goto Github PK