You should see a new folder for your extension inside the extensions/ folder in your project.

Create an extension from a template

To list available templates, run the following:

To create an extension using a template, include the -template option, followed by the template name. For example:

Clone an extension from source control

To clone an existing extension from source control, you must first determine the folder structure of the repo. Some repos house a single extension, while others contain multiple.

Single-extension Repo

A single-extension repo will contain a client/ and/or server/ folders and a manifest.json file in the root of the repo, among other files. For example:

To clone this repo, you may use the MapLarge CLI to clone the extension:

Multi-extension Repo

A multi-extension repo will likely contain folders for each extension at the root of the repo, like this:

In this case, you'll need to clone your repo using git directly.

From the root of your ADK project, run the following, taking care to specify that you want your local clone to be put in the extensions/ folder.

Initialize your ADK project

To build, debug, and package MapLarge extensions, you must initialize your ADK project against a MapLarge server instance. There are two ways to do so.

Init against a remote server

Initialize your project against a running MapLarge server instance. The following command will download several configuration files, TypeScript declarations, and DLLs needed to package an extension that is compatible with that server's particular version.

The -profile option will save the remote server URL (among other options like username/password), allowing you to run other commands (e.g. package, deploy) without needing to include such options every time.

Init against a local repository of server source code

Internal MapLarge developers who have cloned the server source code locally main initialize an ADK project against the local version, allowing them to make server changes in conjuction with ADK extension development.

This option recompiles all of the server TypeScript, so it may take significantly longer to init against a local source repo.

Running your local client-side extension

After initializing a client-side extension, you may run and debug the extension.

This command will compile the TypeScript and LESS files, and start a local ASP.NET server instance that will host your extension. While your extension is hosted locally, any communication with the MapLarge server instance (e.g. queries) will be sent to the server you initialized against. This means that your MapLarge server instance must be running while your local ADK project runs.

While your local project is running, changes to extension source files (e.g. TypeScript files) will automatically trigger a recompile of the extension. After it finishes, you may refresh your browser to see the changes.

Packaging an extension for deployment

In addition to debugging an extension locally (using run), you may also package up an extension and install it directly on a MapLarge server instance, just how it would be in production.

The package command will create a ZIP file and deposit it in the .adk/.deploy/ folder. This ZIP file may be installed on a MapLarge instance via the sidebar menu: Admin -> Extensions.

Deploying an extension from the command-line

The CLI allows developers to package, upload, and install an extension using a single command.

Note: after running the above command, subsequent deploy calls may leave off the authentication parameters, since they are saved to the profile.

Server-side Plugins

ADK projects also support server-side plugins. Code for these plugins resides in the server/ folder of an extension. An extension may include both client-side and server-side components. We recommend developers use Visual Studio to develop server-side plugins.

Server-side plugins must be deployed to a running MapLarge server instance in order to execute them.

CLI Help

For all CLI commands, you may include the -? option to see a list of options.