ArcGIS Maps SDK for JavaScript template

Prerequisites

Node.js 16.0+

The template comes set up with Prettier for formatting. Take a look at their editor integration docs to integrate it into your development environment.

Run project locally

To start:

npm install
npm run dev

Then open your browser at http://localhost:3000/

Create productive build

npm run build

The dist folder then contains all the files for the web app which can either be copied to a web server or pushed to the gh-pages branch to be served at https://arnofiva.github.io/arcgis-core-template.

In order to use the gh-pages approach, see the following instructions. Make sure you remove an existing dist folder if it has been created from a previous build.

Deploy to GitHub Pages

Create `gh-pages` branch

You can skip this part if you used the template by copying all branches, which includs the gh-pages branch that is part of this project.

If you only copied the main branch, follow these steps to create an orphan gh-pages branch (meaning it does not share any history with main):

rm -rf dist
git checkout --orphan gh-pages
git rm -rf .
git commit --allow-empty -m "Init empty branch"
git push origin gh-pages

Return to main branch:

git checkout main

Checkout `gh-pages` branch in `dist/` folder

The following will create a dist folder (fails if it already exists) and make it point to the root of the gh-pages branch:

git worktree add dist gh-pages

Deploy new version on `gh-pages` branch

Once the previous steps have been completed, you can repeat the following every time you want to deploy a new version of your local code:

npm run build
cd dist/
git add .
git commit -am 'Deploy latest version'
git push origin gh-pages
cd ../

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.

arnofiva/arcgis-core-template