VertiGIS Studio Web SDK

This SDK makes it easy to create custom libraries for VertiGIS Studio Web.

Requirements

• The latest LTS version of Node.js
• A code editor of your choice. We recommend Visual Studio Code

Creating a new project

To create a project called web-library run this command:

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 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 in the Developer Center 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

npx @vertigis/web-sdk@latest upgrade

Documentation

Find further documentation on the SDK on the VertiGIS Studio Developer Center

Contributing

See CONTRIBUTING.md for contributing guidelines.