Home

Awesome

Example Plumber App on Heroku

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

Plumber allows you to create a web API by merely decorating your existing R source code with roxygen2-like comments.

Usage

Deploy

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

Execute these commands to get started:

# 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:

The OpenAPI (Swagger) user-interface is available via the /__docs__/ path.

License

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

<!-- Links -->