Skip to content

Latest commit

 

History

History
80 lines (55 loc) · 3.38 KB

README.md

File metadata and controls

80 lines (55 loc) · 3.38 KB
Raw

Esri Leaflet Documentation Site

This repository contains the source code for the Esri Leaflet API Reference, sample code and tutorials found at https://esri.github.io/esri-leaflet.

Instructions

  1. Clone this repository.
  2. npm install -g grunt-cli
  3. npm install
  4. Create a new file, data/secret.json to include an API Key: 
    {
  "api_key": "YOUR API KEY HERE"
}
  5. npm start

In order to update the version of Leaflet, Esri Leaflet or any other plugin displayed in the documentation site:

  1. Find and update the appropriate library version listed in package.json devDependency.
  2. Rerun npm install.
  3. Run npm run integrity (to generate a corresponding Subresource Integrity hash).
  4. Run npm start to confirm locally that this achieved the desired effect.
  5. Send a Pull Request!

Development Tips

Testing/Linting

Before committing, run npm test, which will run ESLint (enforcing the Semistandard style) on all our sample code to ensure the samples are consistently formatted.

File changes will be watched and also linted with ESLint if you have run npm start prior to editing the samples.

VS Code

If you're using VS Code and the ESLint Extension, you can create a new file at .vscode/settings.json with the following contents to enable live linting on the HBS files:

{
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "handlebars"
  ]
}

Local Esri-Leaflet

If you're working on changes to esri-leaflet locally and want to see those changes within the context of the documentation site:

  1. Run npm start in the esri-leaflet project. This will host the built esri-leaflet file at http://localhost:5000/dist/esri-leaflet-debug.js or similar.
  2. In this repository, in \data\devSiteData.json, set the localSource property to true and set the localSourceUrl property to the full url of your esri-leaflet-debug.js file if it's not the same as above.
  3. Run npm start in this project, and the documentation site will be hosted but load the esri-leaflet library locally instead of the CDN version.

Issues

Find a typo or other problem on the website? Please let us know by submitting an issue.

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

Licensing

Copyright © 2015-2019 Esri

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 file.