View the component libraries live samples at https://vertigis-web-incubator.netlify.app.
This project includes a collection of VertiGIS Studio Web component libraries built using the VertiGIS Studio Web SDK. Check out the live samples for an easy way to preview and download the component libraries in your browser without needing to run the project locally. The source for each library is located within the libraries directory of this project.
These component libraries are experimental and provided free of charge without warranty under the MIT license. We will do our best to keep them functional and up-to-date. If you need assistance to modify or improve these libraries, feel free to reach out to our professional services department.
The easiest way to use these component libraries in your VertiGIS Studio Web apps, is by using the Download this library link in the live samples viewer. Once the component library you'd like to use has been downloaded, you can follow the steps on the VertiGIS Studio Developer Center to use the Upload Library feature in the VertiGIS Studio Web Designer.
You will need to install the latest LTS version of Node.js.
You can install the dependencies for all sample projects by running yarn at the root of this repository. The easiest way to install and update yarn is to run npm install -g yarn.
Alternatively you may install the dependencies for a single sample project by running yarn or npm install in the root of a sample directory.
Run yarn start or npm start within the root of a sample directory. For example you can run the mapillary sample by running yarn start within the libraries/mapillary directory. This will launch the VertiGIS Studio Web SDK development server.
Each sample follows the same pattern as the VertiGIS Studio Web SDK. The easiest way to create a new sample is to copy an existing sample directory, and rename the name property in the package.json of your sample to suit. Once created you will need to add your sample to the samples viewer libraries array in the viewer source to have it show up in the list of libraries.
The tests for each sample are located in the cypress/integration directory.
The libraries will need to be built prior to running the test using yarn build:libraries. You can run the tests in interactive watch mode using yarn test:watch, or run all of the tests using yarn test from the root of this project.
To run the samples viewer, first build all of the sample projects by running yarn build:libraries in the root of this project, followed by running yarn start to start the viewer.
Before diving into the VertiGIS Studio Web SDK, be sure to check out our Developer Center to learn the various concepts of building and configuring VertiGIS Studio Web applications. There is a surprising amount that can be accomplished through layout, app config, and VertiGIS Studio Workflow which can be configured in the app config without even needing to use the SDK!