https://github.com/virtualstaticvoid/heroku-plumber-app

Example R Plumber Application on Heroku
https://github.com/virtualstaticvoid/heroku-plumber-app

demo-app heroku heroku-app plumber r template

Last synced: 3 months ago
JSON representation

Example R Plumber Application on Heroku

• Host: GitHub
• URL: https://github.com/virtualstaticvoid/heroku-plumber-app
• Owner: virtualstaticvoid
• License: mit
• Created: 2020-11-07T16:22:05.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-08-31T19:35:51.000Z (about 2 years ago)
• Last Synced: 2024-06-05T02:34:36.919Z (5 months ago)
• Topics: demo-app, heroku, heroku-app, plumber, r, template
• Language: R
• Homepage:
• Size: 117 KB
• Stars: 8
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - virtualstaticvoid/heroku-plumber-app - Example R Plumber Application on Heroku (R)

README

        
# Example Plumber App on Heroku

This is an example [Plumber][plumber] application, which uses [heroku-buildpack-r][buildpack] for Heroku.

> Plumber allows you to create a web API by merely decorating your existing R source code

> with roxygen2-like comments.

## Usage

[![Deploy][button]][deployapp]

You can use this project as a template for creating Plumber applications on Heroku.

Execute these commands to get started:

```bash

# get the sources

git clone https://github.com/virtualstaticvoid/heroku-plumber-app.git

cd heroku-plumber-app

# optionally, reinitialize git

rm -rf .git

git init -b main

git add --all

git commit -m "initial"

# create a new heroku application, set the buildpack and deploy

heroku create --stack=heroku-20 --buildpack vsv/heroku-buildpack-r

# deploy

git push heroku main

# view the application

heroku open /__docs__/

```

The following paths are provided:

* [`/echo?msg=MSG`](plumber.R#L14)

* [`/plot`](plumber.R#L21)

* [`/sum?x=X&y=Y`](plumber.R#L30)

The OpenAPI (Swagger) user-interface is available via the [`/__docs__/`](app.R#L10) path.

## License

MIT License. Copyright (c) 2020 Chris Stefano. See [LICENSE](LICENSE) for details.

[buildpack]: https://github.com/virtualstaticvoid/heroku-buildpack-r

[button]: https://www.herokucdn.com/deploy/button.svg

[deployapp]: https://heroku.com/deploy?template=https://github.com/virtualstaticvoid/heroku-plumber-app/tree/main

[plumber]: https://www.rplumber.io