https://github.com/vertigis/vertigis-web-samples
A collection of VertiGIS Studio Web SDK samples
https://github.com/vertigis/vertigis-web-samples
geocortex samples sdk vertigis web
Last synced: 4 months ago
JSON representation
A collection of VertiGIS Studio Web SDK samples
- Host: GitHub
- URL: https://github.com/vertigis/vertigis-web-samples
- Owner: vertigis
- License: mit
- Created: 2020-04-15T21:32:35.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2026-01-29T21:13:51.000Z (5 months ago)
- Last Synced: 2026-01-30T09:55:16.296Z (5 months ago)
- Topics: geocortex, samples, sdk, vertigis, web
- Language: TypeScript
- Homepage: https://vertigis-web-samples.netlify.app
- Size: 3.77 MB
- Stars: 8
- Watchers: 3
- Forks: 7
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# VertiGIS Studio Web SDK Samples
View the samples at [https://vertigis-web-samples.netlify.app](https://vertigis-web-samples.netlify.app).
This project includes a collection of samples that demonstrates how to configure and customize [VertiGIS Studio Web](https://vertigisstudio.com/products/vertigis-studio-web/) apps using the [VertiGIS Studio Web SDK](https://developers.vertigisstudio.com/docs/web/sdk-overview/). Before diving into the SDK, be sure to check out our [Developer Center](https://developers.vertigisstudio.com/docs/web/overview/) to learn the various concepts of building and configuring VertiGIS Studio Web applications. There is a surprising amount that can be accomplished through [layout](https://developers.vertigisstudio.com/docs/web/configuration-layout-getting-started/), [app config](https://developers.vertigisstudio.com/docs/web/configuration-app-config-getting-started/), and [VertiGIS Workflow](https://vertigisstudio.com/products/vertigis-studio-workflow/) which can be [configured in the app config](https://developers.vertigisstudio.com/docs/web/tutorial-run-workflow-app-config/) without even needing to use the SDK!
Check out the [hosted samples viewer](https://vertigis-web-samples.netlify.app/) for an easy way to run the samples in your browser without needing to run the project locally. The source for each sample is located within the [samples](samples) directory of this project.
## Running the Samples locally
You will need to install the latest LTS version of [Node.js](https://nodejs.org/).
### Installing dependencies
You can install the dependencies for all sample projects by running [`yarn`](https://yarnpkg.com/) 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.
### Running a sample
Run `yarn start` or `npm start` within the root of a sample directory. For example you can run the `i18n` sample by running `yarn start` within the [samples/i18n](samples/i18n) directory. This will launch the VertiGIS Studio Web SDK development server.
### Creating a new sample
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` config in [samples/library-viewer/app/app.json](samples/library-viewer/app/app.json) to have it show up in the list of samples.
### Testing
The tests for each sample are located in the [cypress/integration](cypress/integration) directory.
The samples will need to be built prior to running the test using `yarn build:samples`. You can run the tests in interactive watch mode using `yarn test:watch`, this will allow you to run individual tests, or use `yarn test` from the root of this project to run all of the tests .
### Running the Samples Viewer Locally
To run the samples viewer, first build all of the sample projects by running `yarn build:samples` in the root of this project, followed by running `yarn start` to start the viewer.
## Documentation
You can learn more on the [VertiGIS Studio Developer Center](https://developers.vertigisstudio.com/docs/web/overview/).