https://github.com/ElianHugh/hotwater

🌡️💧 live reload for plumber APIs
https://github.com/ElianHugh/hotwater

file-watcher live-reload plumber r reload

Last synced: 5 months ago
JSON representation

🌡️💧 live reload for plumber APIs

• Host: GitHub
• URL: https://github.com/ElianHugh/hotwater
• Owner: ElianHugh
• License: gpl-3.0
• Created: 2024-04-09T08:40:23.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-16T07:49:26.000Z (7 months ago)
• Last Synced: 2024-11-13T17:54:21.644Z (5 months ago)
• Topics: file-watcher, live-reload, plumber, r, reload
• Language: R
• Homepage: https://elianhugh.github.io/hotwater/
• Size: 1.02 MB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• jimsghstars - ElianHugh/hotwater - 🌡️💧 live reload for plumber APIs (R)

README

        


# 🌡️💧 hotwater

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

[![hotwater status badge](https://elianhugh.r-universe.dev/badges/hotwater)](https://elianhugh.r-universe.dev/hotwater)

[![Codecov test coverage](https://codecov.io/gh/ElianHugh/hotwater/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ElianHugh/hotwater?branch=main)

[![R-CMD-check](https://github.com/ElianHugh/hotwater/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ElianHugh/hotwater/actions/workflows/R-CMD-check.yaml)

- autoreload for plumber

- auto-refresh the browser when a change is made

- run from the commandline with the `/exec/hotwater` bash script

## Installation

You can install the development version of hotwater from

[GitHub](https://github.com/) with:

```r

# install.packages("devtools")

devtools::install_github("ElianHugh/hotwater")

```

## Example

Hotwater can be run via an R session:

```r

hotwater::run(

    system.file("examples", "plumber.R", package = "hotwater"),

    port = 9999L

)

```

```r

✔ Server running on <127.0.0.1:9999> [17ms]

→ Watching ./path/to/ for changes...

```

or a terminal using the bash script:

```sh

hotwater -f my/plumber/api.R -p 9999

```

```r

✔ Server running on <127.0.0.1:9999> [17ms]

→ Watching ./path/to/ for changes...

```