https://github.com/bcgov/smk-cli

The Command Line Interface enables users to rapidly create and edit SMK map configuration, including data consumption via OGC and Esri ReST data access services and local data files.
https://github.com/bcgov/smk-cli

citz databc leaflet map-kit mapping mapping-tools maps nodejs opensource smk smk-cli vuejs

Last synced: 3 months ago
JSON representation

The Command Line Interface enables users to rapidly create and edit SMK map configuration, including data consumption via OGC and Esri ReST data access services and local data files.

• Host: GitHub
• URL: https://github.com/bcgov/smk-cli
• Owner: bcgov
• License: apache-2.0
• Created: 2020-08-20T23:50:39.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-10-31T15:25:26.000Z (about 1 year ago)
• Last Synced: 2024-04-26T23:02:53.533Z (9 months ago)
• Topics: citz, databc, leaflet, map-kit, mapping, mapping-tools, maps, nodejs, opensource, smk, smk-cli, vuejs
• Language: JavaScript
• Homepage: https://bcgov.github.io/smk-cli
• Size: 9.14 MB
• Stars: 4
• Watchers: 10
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Simple Map Kit Command-line Interface

![img](https://img.shields.io/badge/Lifecycle-Stable-97ca00)

A command line utility and visual editor for creating and editing [Simple Map Kit](https://github.com/bcgov/smk) applications.

# Documentation

Check out the SMK CLI documentation available [here](https://bcgov.github.io/smk-cli/)

# Installation

The SMK CLI can be installed via NPM in two different ways;

either local to the current project, or globally for your whole system.

## Global installation

To install the command globally, so it can be used from any project in our system, use this command:

    npm install --global @bcgov/smk-cli

This may require you to use administrative rights (or `sudo`) on your machine, depending on how it is configured.

Test that installation was successful by executing:

    smk help

## Local installation

To install the command local to a particular project, first change into the directory of the project:

    cd 

    npm install --save-dev @bcgov/smk-cli

The `smk` will be installed for that particular project, as a dev dependency.

Test that installation was successful by executing:

    node_modules/.bin/smk help

# Commands

    smk create [name]

This will launch the command line tool for creating a new SMK application.

You can provide a name, it will be the name of the new subdirectory for the application.

This will download the latest version of SMK from GitHub and build a map configuration for you to start working with.

    smk edit [-p port]

Once you've created an SMK application, or if you have an existing one, you can run this command to launch the visual editor.

For more information on the SMK project, or to read documentation on SMK development and building your finished SMK app, see https://bcgov.github.io/smk/

# Uninstall

    npm uninstall --global @bcgov/smk-cli