npm package: @smartparks/node-red-contrib-earthranger
Description: An adapter for node-red to easily connect to the Earth Ranger API.
Author: Smart Parks
Latest version: 1.4.0

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]

<!-- PROJECT LOGO -->
<br />
<p align="center">
  <a href="https://github.com/SmartParksOrg/node-red-contrib-earthranger">
    <img src="src/img/smp-logo-ret.jpg" alt="Logo" width="265" height="150"/>
  </a>

  <h3 align="center">Smart Parks Earthranger Node-Red node</h3>

  <p align="center">
    With this Node-Red node you can interface with the REST API of your EarthRanger application.
    <br />
    <a href="https://github.com/SmartParksOrg/node-red-contrib-earthranger"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/SmartParksOrg/node-red-contrib-earthranger">View Demo</a>
    ·
    <a href="https://github.com/SmartParksOrg/node-red-contrib-earthranger/issues">Report Bug</a>
    ·
    <a href="https://github.com/SmartParksOrg/node-red-contrib-earthranger/issues">Request Feature</a>
  </p>
</p>

<!-- TABLE OF CONTENTS -->

## Table of Contents

- [About the Project](#about-the-project)
  - [Built With](#built-with)
- [Getting Started](#getting-started)
  - [Prerequisites](#prerequisites)
  - [Installation](#installation)
- [Usage](#usage)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Authors](#authors)

<!-- ABOUT THE PROJECT -->

## About The Project

This Node-Red core provides diverse nodes. In every node you can list, get, create, update and delete all relevant editable models.

TODO: add reference to complete wiki when in that stage

### Built With

- [Node-Red](https://github.com/node-red/node-red)

<!-- GETTING STARTED -->

## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

- npm

```sh
sudo npm install npm@latest -g
```

- node-red

```sh
sudo npm install -g --unsafe-perm node-red
```

### Installation

1. Clone the repo

```sh
git clone https://github.com/adminfriso/node-red-contrib-earthranger.git
```

2. Install NPM packages

```sh
npm install
```

3. Start Node-Red

```sh
node-red
```

<!-- USAGE EXAMPLES -->

## Usage

TODO: insert examples

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

_For more examples, please refer to the [Documentation](https://example.com)_

<!-- ROADMAP -->

## Roadmap

See the [open issues](https://github.com/SmartParksOrg/node-red-contrib-earthranger/issues) for a list of proposed features (and known issues).

<!-- CONTRIBUTING -->

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<!-- LICENSE -->

## License

Distributed under the MIT License. See `LICENSE` for more information.

<!-- Authors -->

## Authors

- **Friso Modderman - Smart Parks** - _Initial work_ - [adminfriso](https://github.com/adminfriso)

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[contributors-shield]: https://img.shields.io/github/contributors/SmartParksOrg/node-red-contrib-earthranger.svg?style=flat-square
[contributors-url]: https://github.com/SmartParksOrg/node-red-contrib-earthranger/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/SmartParksOrg/node-red-contrib-earthranger.svg?style=flat-square
[forks-url]: https://github.com/SmartParksOrg/node-red-contrib-earthranger/network/members
[stars-shield]: https://img.shields.io/github/stars/SmartParksOrg/node-red-contrib-earthranger.svg?style=flat-square
[stars-url]: https://github.com/SmartParksOrg/node-red-contrib-earthranger/stargazers
[issues-shield]: https://img.shields.io/github/issues/SmartParksOrg/node-red-contrib-earthranger.svg?style=flat-square
[issues-url]: https://github.com/SmartParksOrg/node-red-contrib-earthranger/issues
[license-shield]: https://img.shields.io/github/license/SmartParksOrg/node-red-contrib-earthranger.svg?style=flat-square
[license-url]: https://github.com/SmartParksOrg/node-red-contrib-earthranger/blob/main/LICENSE
[product-screenshot]: src/img/screenshot.png