{golem}

golem is an opinionated framework for building production-grade shiny applications.

About

You’re reading the doc about version : 0.3.4.9002

Tool series

This package is part of a series of tools for Shiny, which includes:

• golem - https://github.com/ThinkR-open/golem
• shinipsum - https://github.com/ThinkR-open/shinipsum
• {fakir} - https://github.com/ThinkR-open/fakir
• {shinysnippets} - https://github.com/ThinkR-open/shinysnippets

Resources

The Book :

• https://engineering-shiny.org/
• paper version of the book “Engineering Production-Grade Shiny Apps”

Blog posts :

Building Big Shiny Apps

• Part 1: https://rtask.thinkr.fr/building-big-shiny-apps-a-workflow-1/
• Part 2: https://rtask.thinkr.fr/building-big-shiny-apps-a-workflow-2/

Make a Fitness App from scratch

Slide decks

• useR! 2019 : A Framework for Building Robust & Production Ready Shiny Apps
• ThinkR x RStudio Roadshow,Paris : Production-grade Shiny Apps with {golem}
• rstudio::conf(2020) : Production-grade Shiny Apps with golem
• barcelonar (2019-12-03) : Engineering Production-Grade Shiny Apps with {golem}

Video

• {golem} and Effective Shiny Development Methods
• Hands-on demonstration of {golem}
• useR! 2019 : A Framework for Building Robust & Production Ready Shiny Apps
• 🇫🇷 Introduction to {golem}
• rstudio::conf(2020) : Production-grade Shiny Apps with golem
• 🇫🇷 Rencontres R 2021 : Conception d’applications Shiny avec {golem}
• 🇫🇷 Déploiement d’une application {shiny} dans docker avec {renv} et {golem}

Cheatsheet

• {golem} cheatsheet

Examples apps

These are examples from the community. Please note that they may not necessarily be written in a canonical fashion and may have been written with different versions of golem or shiny.

• https://github.com/seanhardison1/vcrshiny
• https://github.com/Nottingham-and-Nottinghamshire-ICS/healthcareSPC
• https://github.com/marton-balazs-kovacs/tenzing
• https://github.com/shahreyar-abeer/cranstars

You can also find apps at:

• https://connect.thinkr.fr/connect/
• https://github.com/ColinFay/golemexamples

Installation

• You can install the stable version from CRAN with:

install.packages("golem")

• You can install the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("Thinkr-open/golem")

Launch the project

Create a new package with the project template:

Step by step guide

See full documentation in the {pkgdown} website:

[CRAN] https://thinkr-open.github.io/golem/

[dev] https://thinkr-open.github.io/golem/dev/

After project creation, you’ll land on dev/01_start.R. There are also dev/02_dev.R and dev/03_deploy.R

These files are used to keep a track of all the steps you’ll be following while building your app.

Step 1 : Getting Started

Read the Getting Started Vignette for a detailed walkthrough.

Step 2 : Day to Day Dev

Read Day to Day Dev Vignette for a detailed walkthrough.

Step 3: deploy

Read Deploying Apps with {golem} Vignette for a detailed walkthrough.

CoC

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Note for the contributors

Please style the files according to grkstyle::grk_style_transformer()

# If you work in RStudio
options(styler.addins_style_transformer = "grkstyle::grk_style_transformer()")

# If you work in VSCode
options(languageserver.formatting_style = function(options) {
  grkstyle::grk_style_transformer()
})