https://github.com/Appsilon/rhino-showcase

An example app built with Rhino to showcase its features
https://github.com/Appsilon/rhino-showcase

Last synced: 9 days ago
JSON representation

An example app built with Rhino to showcase its features

• Host: GitHub
• URL: https://github.com/Appsilon/rhino-showcase
• Owner: Appsilon
• Created: 2022-02-22T08:17:45.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-11T13:54:07.000Z (5 months ago)
• Last Synced: 2024-08-13T07:11:23.539Z (4 months ago)
• Language: R
• Homepage: https://connect.appsilon.com/olympic_history_map
• Size: 14 MB
• Stars: 27
• Watchers: 19
• Forks: 3
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - Appsilon/rhino-showcase - An example app built with Rhino to showcase its features (R)

README

        
# Rhino Showcase - Olympic History Map

This app is built with [Rhino](https://github.com/Appsilon/rhino).

You can see a deployed version here: 

[Rhino Showcase Demo](https://connect.appsilon.com/olympic_history_map/).

It is meant to be a showcase of the its features

and a place for code/configuration which is not used often enough to be added to the package itself.

## Prerequisites

This is an application built in [Shiny](https://shiny.rstudio.com/).

To run it, make sure you have R (>= 4.0.0) installed.

For JavaScript and Sass development you'll also need

[Node.js](https://nodejs.org/en/download/) (>= 16.0.0).

## Dependencies

Run `renv::restore(clean = TRUE)` to synchronize the project library with the lockfile

when you initially clone the repo or switch branches.

## Data

Application-ready data is included in `app/data`.

However, if you want to generate this data from raw sources, run `source("./scripts/generate_data.R")`

## Running

To run the app, use `Rscript -e 'shiny::runApp(launch.browser = TRUE)'`.

## Deployment

You can use the RStudio GUI to deploy the app to RStudio Connect or shinyapps.io.

You only need to include the following files:

`.Rprofile`, `dependencies.R`, `app.R`, and `app/` directory.

### Docker

The application can also be packaged as a Docker container using `rocker/shiny` as a

base image.

To build the image locally, execute:

```bash

docker build --tag rhino-showcase .

```

To run the container, execute:

```bash

docker run --rm -it -p 3838:3838 rhino-showcase

```

The application should be available under `localhost:3838` on your local

workstation.

## Development

This project uses [renv](https://rstudio.github.io/renv/) to manage R package dependencies.

To add/remove packages, edit the `dependencies.R` file and run the following commands:

```r

renv::install() # Install added packages

renv::snapshot() # Update the lockfile

renv::restore(clean = TRUE) # Uninstall removed packages

```