Package index • aurora

Scaffolding

Create the canonical app layout and add routes.

aurora_create_app(): Scaffold a new aurora app
aurora_add_route(): Add an API route to an aurora app

Build & run

Compile the UI, assemble the API, run locally.

aurora_build_ui(): Build the static UI for an aurora app
aurora_app(): Assemble an aurora app as a plumber2 API
aurora_run(): Run an aurora app locally
aurora_config(): Read the app's data/config.yml, anchored to the app root
aurora_check(): Check an aurora app for common problems

UI

aurora_component(): Wire a UI element to a JSON API endpoint

Serializers

NULL-safe helpers for JSON responses.

aurora_unbox(): Unbox a scalar for a JSON response, NULL-safe
aurora_geojson(): Encode an sf object as GeoJSON for a JSON response, NULL-safe
aurora_unique(): Sorted unique non-missing values, for filter options

Data

Globals-free, hot-reloading data store for handlers.

aurora_data_store(): Create a hot-reloading data store
aurora_data_register(): Register a dataset in a data store
aurora_data_get(): Read a dataset from a store, reloading if the file changed
aurora_data_names(): Names of the datasets registered in a store

Deploy

Docker images and ShinyProxy / Ruscker specs.

aurora_dockerfile(): Generate a Dockerfile (and .dockerignore) for an aurora app
aurora_build_image(): Build (and optionally push) a Docker image for an aurora app
aurora_shinyproxy_yaml(): Emit a ShinyProxy app-spec block for an aurora image
aurora_ruscker_yaml(): Emit a Ruscker app-spec block for an aurora image

Auth

Optional JWT-cookie authentication scheme.

aurora_auth_jwt(): JWT-cookie authentication scheme
aurora_jwt_token(): Mint a signed JWT for an auth scheme
aurora_jwt_decode(): Decode and verify a JWT
aurora_jwt_guard(): Guard a request, aborting with 401 unless it carries a valid token
aurora_set_auth_cookie() aurora_clear_auth_cookie(): Set or clear the auth cookie on a response