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

https://github.com/vertigis/vertigis-web-sdk

The SDK for VertiGIS Studio Web
https://github.com/vertigis/vertigis-web-sdk

arcgis geocortex gis sdk vertigis web

Last synced: 4 months ago
JSON representation

The SDK for VertiGIS Studio Web

Awesome Lists containing this project

README

          

# VertiGIS Studio Web SDK

![CI/CD](https://github.com/vertigis/vertigis-web-sdk/workflows/CI/CD/badge.svg)

This SDK makes it easy to create custom libraries for [VertiGIS Studio Web](https://vertigisstudio.com/products/vertigis-studio-web/).

## Requirements

- The latest LTS version of [Node.js](https://nodejs.org/en/download/)
- A code editor of your choice. We recommend [Visual Studio Code](https://code.visualstudio.com/)

## Creating a new project

To create a project called _web-library_ run this command:

```bash
npx @vertigis/web-sdk create web-library
```

This will bootstrap a new project in the specified directory to quickly get you up and running with the VertiGIS Studio Web SDK.

## Available Scripts

Inside the newly created project, you can run some built-in commands:

### `npm start`

Runs the project in development mode. Open [http://localhost:3001](http://localhost:3001) to view it in the browser.

The page will automatically reload if you make changes to the code. You will see build errors and warnings in the console.

### `npm run build`

Builds the library for production to the `build` folder. It optimizes the build for the best performance.

Your custom library is now ready to be deployed!

See the [section about deployment](https://developers.vertigisstudio.com/docs/web/sdk-deployment/) in the [Developer Center](https://developers.vertigisstudio.com/docs/web/overview/) for more information.

## Upgrading

To update a previously created project to the latest version of the Web SDK, navigate to the root directory of that project and run

```sh
npx @vertigis/web-sdk@latest upgrade
```

## Documentation

Find [further documentation on the SDK](https://developers.vertigisstudio.com/docs/web/sdk-overview/) on the [VertiGIS Studio Developer Center](https://developers.vertigisstudio.com/docs/web/overview/)

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for contributing guidelines.