README.md
In alexvannoy/ExampleRAPI: A small example R web application

ExampleRAPI

This is primarily an R repo that holds a tiny R web-app to be used in my Kubernetes learning experience. However, it should also function as a passable template for other R web services.

test.bat

Note: This isn't set up to run out-of-the-box with docker buildx. This is just for local dev work on a windows box. It wouldn't take a much effort to implement, but this is primarily for the quick-n-dirty, first pass type of build.

Running test build will build the image r-webapp:dev that houses the web-app.

Running test run-bash will build the image r-webapp:dev with a bash entrypoint to help debug internal issues

Running test web-app will build the image run-r-webapp that runs the web app on localhost:8080. The actual route is set to localhost:8080/api but that's set in the run_app.R function when the add_swagger_ui() path is assigned.

buildme.sh

A dummy script that builds and pushes the docker image to my docker repository. First note that this abuses my locally cached creds. I'm on a windows box, so I'm not having to deal with the Linux PAT crap yet. I wrote this specifically to abuse later in a cluster where I pull the docker image from a public registry (mine). I also strongly recommend you set up a buildx thing so that you make docker images for all use cases. Really the arm and amd ones are the only things that were majorly important as the Raspberry Pis I'm using in a cluster wanted whichever my laptop isn't.

docker buildx create --name multiarch --use --platform linux/arm64,linux/amd64,linux/arm/v7,linux/arm/v6

Use Cases

Fork this repo
Add whatever functions and stuff you need in /R/
Add any endpoint handlers to /R/run_app
Change the name of the package if you want, but that changes in a lot of places, so good luck.
If you use buildme.sh, you'll need to change the docker.io repo.
You'll also need to have valid cached creds for that to run.