# webgis4u-cli

> The webgis4u CLI for creating html templates

Latest version **0.0.1-development.12** (published 2019-11-12) · BSD-2-Clause license · 0 weekly downloads

## Install

```sh
npm install webgis4u-cli
pnpm add webgis4u-cli
yarn add webgis4u-cli
bun add webgis4u-cli
```

Provides the command `webgis4u-cli`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1-development.12 |
| Published | 2019-11-12 |
| First published | 2019-11-11 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 29.7 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | maschino |

## Links

- npm: https://www.npmjs.com/package/webgis4u-cli
- Repository: https://github.com/environment-agency-austria/webgis4u
- Homepage: https://github.com/environment-agency-austria/webgis4u#readme
- Issues: https://github.com/environment-agency-austria/webgis4u/issues
- npm.io page: https://npm.io/package/webgis4u-cli

## Dependencies (2)

- [pug](https://npm.io/package/pug.md) ^2.0.4
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1

## Recent versions

- 0.0.1-development.12 (latest) — 2019-11-12
- 0.0.1-development.11 — 2019-11-12
- 0.0.1-development.10 — 2019-11-11
- 0.0.1-development.9 — 2019-11-11
- 0.0.1-development.8 — 2019-11-11
- 0.0.1-development.7 — 2019-11-11

## README

# webgis4u
`webgis4u` is a javascript client to visualise geographical maps based on [OpenLayers](https://openlayers.org/).

[![npm](https://img.shields.io/npm/v/webgis4u.svg)](https://www.npmjs.com/package/webgis4u)
[![GitHub license](https://img.shields.io/github/license/environment-agency-austria/webgis4u.svg)](https://github.com/environment-agency-austria/webgis4u/blob/master/LICENSE)
[![travis](https://travis-ci.com/environment-agency-austria/webgis4u.svg?branch=master)](https://travis-ci.com/environment-agency-austria/webgis4u)
[![Greenkeeper badge](https://badges.greenkeeper.io/environment-agency-austria/webgis4u.svg)](https://greenkeeper.io/)
[![Coverage Status](https://coveralls.io/repos/github/environment-agency-austria/webgis4u/badge.svg?branch=master)](https://coveralls.io/github/environment-agency-austria/webgis4u?branch=master)


## Usage
### Install
Use npm/yarn to install `webgis4u` as a dependency.
```bash
$> npm i webgis4u
```
or
```bash
$> yarn add webgis4u
```

### HTML Templates
To help you get started with the HTML structure for `webgis4u`, the `webgis4u-cli` is provided.
```bash
$> npm i webgis4u-cli
```
or
```bash
$> yarn add webgis4u-cli
```

This tool can be used to generate templates for maps by using the command line
```bash
$> webgis4u-cli -out <path> [-templates <path>]
```

Options:
* `out` (required): Path where the generated `.html` files will be saved
* `templates` (options): Path to a folder containing additional templates, that will be used in the template generation process. It looks for `.html` files names `copyright`, `card_menu`, `link_panel`, `tool_switcher_functions`, `tool_switcher_layers`, `info_panel_header`, `info_panel_footer`, `legend`


## Development
### API Documentation
The API documentation can be found [here](https://environment-agency-austria.github.io/webgis4u/).


### Module and Naming Conventions
The naming convention is intended to match the one established by OpenLayers. Have a look [here](https://openlayers.org/en/latest/doc/tutorials/background.html#module-and-naming-conventions).

### Recommended workflow
Link this package in the project where you'll be using it. You can then run `yarn start` inside this repo and
see your changes immediately:
* `webgis4u/ $ yarn link` to register this project locally. This is only needed the first time.
* `webgis4u/ $ yarn start` to start webpack in watch mode
* `project/ $ yarn link webgis4u` to use your local copy of webgis4u inside your project
* `project/ $ yarn start` (or whatever command you use to start the project locally)

## Contribute
If you are intereseted in contributing be sure to check out the information on [how to contribute](./.github/CONTRIBUTING.md) as it provides useful information on the current project setup.

---
_Source: https://npm.io/package/webgis4u-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._