@vertigis/sdk-library
v2.0.2
Published
Shared routines and config files used by VertiGIS Studio SDKs
Readme
VertiGIS SDK Library
This repo contains a library of configuration and routines that are shared between the VertiGIS Web and Workflow SDK projects.
Requirements
- The latest LTS version of Node.js.
- A code editor of your choice. We recommend Visual Studio Code.
Testing
To test a generated project (either Web or Workflow):
- Download both this repo and the sdk repo you are interested in.
- In this repo run
npm iand thennpm link. - In the Web or Workflow SDK repo run
npm iand thennpm link @vertigis/sdk-library - Generate an SDK project with
npm create ... - Then once the project is created navigate to it and run
npm link @vertigis/web-sdkornpm link @vertigis/workflow-sdkas appropriate. - Then you can
npm buildnpm startetc as normal in the project and the code from your development copies will be executed.
To run the tests in development:
- The above setup is sufficent to run the tests from the
web-sdkorworkflow-sdkrepos. Normally this should be enough. - To run in development tests from
sdk-libraryagainst development copies of the sdk repos you need to change thenpm packstatement intest/e2e/index.jsto point at your local sdk repos. - Assuming everything is in the same folder, look for this line and change it like this:
-- await $`npm pack @vertigis/${process.env.SDK_PLATFORM}-sdk ...
++ await $`npm pack ../vertigis-${process.env.SDK_PLATFORM}-sdk ...- This will cause
sdk-libraryto use packaged code from your development copies to run the tests.
Contributing
See CONTRIBUTING.md for contributing guidelines.
