Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ralucanicola/arcgis-template


https://github.com/ralucanicola/arcgis-template

Last synced: 25 days ago
JSON representation

Awesome Lists containing this project

README

        

# ArcGIS app template

Application template using ArcGIS Maps SDK for JavaScript, React and Calcite.

- [x] Authentication
- [x] Calcite components for UI
- [x] Redux for state management
- [x] Thunk middleware for async operations
- [x] Responsive design (mobile and desktop)
- [x] Reading/setting state from/in URL params
- [x] Error display using Calcite alerts (only displaying the last error)
- [x] Dismissable intro screen
- [x] UI animations (using Framer Motion)
- [ ] Localization support?
- [ ] Tests?

## Instructions:

You need to have [git](https://git-scm.com/) and [npm](https://www.npmjs.com/) installed on your machine.
Clone this repository to your computer with the following command:

```sh
git clone [email protected]:RalucaNicola/arcgis-template.git
```

Install the modules that are need to run the app:

```sh
npm install
```

## Running the app for development

Now you can start the vite development server to test the app on your local machine:

```sh
# it will start a server instance and begin listening for connections from localhost on port 3000
npm run dev
```

## Deployment

To build/deploy the app, you can simply run:

```sh
# it will place all files needed for deployment into the /dist directory
npm run build
```

Copy the content of the `/dist` directory to the server where you want to deploy the application.

## Requirements

- [ArcGIS Maps SDK for JavaScript](https://developers.arcgis.com/javascript/index.html)

## Issues

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

## Contributing

Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](https://github.com/esri/contributing).

## Licensing

Copyright 2022 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.txt](license.txt) file.