Installing | Getting started | Create a package | dev/01_start.R | Fill the DESCRIPTION | Set common Files | Init Tests | Add various tools | Remove current favicon | Add a new one | Try the app
Package: golem 1.0.0
Colin Fay
golem: A Framework for Robust Shiny Applications
An opinionated framework for building a production-ready 'Shiny' application. This package contains a series of tools for building a robust 'Shiny' application from start to finish.
Authors:
golem_1.0.0.tar.gz
golem_1.0.0.zip(r-4.7)golem_1.0.0.zip(r-4.6)golem_1.0.0.zip(r-4.5)
golem_1.0.0.tgz(r-4.6-any)golem_1.0.0.tgz(r-4.5-any)
golem_1.0.0.tar.gz(r-4.7-any)golem_1.0.0.tar.gz(r-4.6-any)
golem_1.0.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
golem/json (API)
| # Install 'golem' in R: |
| install.packages('golem', repos = c('https://thinkr-open.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/thinkr-open/golem/issues
Pkgdown/docs site:https://thinkr-open.github.io
golemversehacktoberfestshinyshiny-appsshiny-rshinyapps
Last updated from:14294c6208. Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel-x86_64 | OK | 141 | ||
| source / vignettes | OK | 218 | ||
| linux-release-x86_64 | OK | 161 | ||
| macos-release-arm64 | OK | 114 | ||
| macos-oldrel-arm64 | OK | 96 | ||
| windows-devel | OK | 132 | ||
| windows-release | OK | 117 | ||
| windows-oldrel | OK | 108 | ||
| wasm-release | OK | 123 |
Exports:activate_jsadd_css_fileadd_dockerfileadd_dockerfile_herokuadd_dockerfile_shinyproxyadd_dockerfile_with_renvadd_dockerfile_with_renv_herokuadd_dockerfile_with_renv_shinyproxyadd_empty_fileadd_fctadd_github_actionadd_gitlab_ciadd_html_templateadd_js_fileadd_js_handleradd_js_input_bindingadd_js_output_bindingadd_moduleadd_partial_html_templateadd_positconnect_fileadd_r6add_resource_pathadd_rscignore_fileadd_sass_fileadd_shinyappsio_fileadd_shinyserver_fileadd_ui_server_filesadd_utilsamend_golem_configapp_devapp_prodbrowser_buttonbrowser_devbundle_resourcescat_devcreate_golemcss_templatedetach_all_attacheddisable_autoloaddocument_and_reloadempty_templateexpect_html_equalexpect_runningexpect_shinytagexpect_shinytaglistfaviconfct_templatefill_descget_current_configget_golem_nameget_golem_optionsget_golem_versionget_golem_wdgolem_welcome_pageinstall_dev_depsinvoke_jsis_golemis_runningjs_handler_templatejs_templatemaintenance_pagemake_devmessage_devmodule_templatepkg_namepkg_pathpkg_versionprint_devproject_hookremove_faviconrun_devsanity_checksass_templateset_golem_nameset_golem_optionsset_golem_versionset_golem_wduse_agent_skillsuse_bundled_htmluse_claude_skillsuse_external_css_fileuse_external_fileuse_external_html_templateuse_external_js_fileuse_faviconuse_internal_css_fileuse_internal_fileuse_internal_html_templateuse_internal_js_fileuse_module_testuse_readme_rmduse_recommended_testsuse_skilluse_skillsuse_utils_serveruse_utils_test_serveruse_utils_test_uiuse_utils_uiwarning_devwith_golem_options
Dependencies:attemptbase64encbslibcachemclicodetoolscommonmarkconfigdigestfastmapfontawesomefsgluehtmltoolshttpuvjquerylibjsonlitelaterlifecyclemagrittrmemoisemimeotelpromisesR6rappdirsRcpprlangsassshinysourcetoolswithrxtableyaml
Getting started
Last update: 2026-06-12
Started: 2025-05-06
Day to day development
Day to day development with | Launching the app | dev/02_dev.R | Add dependencies | Add modules | Add function files | Add external files | Adding these external resources to your app | Add a data-raw folder | Add tests | Documentation | Vignette | Code coverage | Using {golem} dev functions
Last update: 2026-06-12
Started: 2025-05-06
Deploy your app
About the run_app() function | Deploying Apps with | Posit Products | Docker | Without using | Using {renv} - CASE 1 : you didn't use renv during development process | Using {renv} - CASE 2: you already have a renv.lock file for your project
Last update: 2026-06-12
Started: 2025-05-06
JavaScript
Using {golem} js functions | golem::invoke_js() | A quick intro to jQuery selectors
Last update: 2026-06-12
Started: 2025-05-06
Configuration
Two Ways to Manage Production vs Development Mode | About inst/golem-config.yml | Setting golem-config | Using golem-config | app_config.R | golem_config vs golem_options | Connecting Back to the R Options Approach | The R Options Mechanism | Important: The Two Mechanisms Are Independent | Best Practices | Note for {golem} < 0.2.0 users
Last update: 2026-06-12
Started: 2025-05-06
Extending {golem}
Project Hooks | What it is | How it works | Defining your own project_hook | Example | Module templates | Defining your own module_template | JS & CSS & SASS templates | Defining your own template | Turn on the maintenance mode | How to set the maintenance mode | The maintenance page
Last update: 2026-06-12
Started: 2025-05-06
Contribute to Golem
Contributing to Golem | Note for the contributors | Code style | Actual state of the package | Code of Conduct
Last update: 2026-06-12
Started: 2025-05-06
Resources
Examples apps | Book | Cheatsheet
Last update: 2025-05-06
Started: 2025-05-06
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Interact with JavaScript built-in Functions | activate_js invoke_js |
| Create a Dockerfile for your App | add_dockerfile add_dockerfile_heroku add_dockerfile_shinyproxy add_dockerfile_with_renv add_dockerfile_with_renv_heroku add_dockerfile_with_renv_shinyproxy |
| Add fct_ and utils_ files | add_fct add_r6 add_utils |
| Add deployment CI for GitHub Actions | add_github_action |
| Add deployment CI for GitLab | add_gitlab_ci |
| Create Files | add_css_file add_empty_file add_html_template add_js_file add_js_handler add_js_input_binding add_js_output_binding add_partial_html_template add_sass_file add_ui_server_files |
| Create a module | add_module |
| Add an 'app.R' at the root of your package to deploy on RStudio Connect | add_positconnect_file add_rconnect_file add_rscignore_file add_shinyappsio_file add_shinyserver_file |
| Add resource path | add_resource_path |
| '{golem}' addins | addins go_to_app_server go_to_app_ui go_to_deploy go_to_dev go_to_run_app go_to_run_dev go_to_start insert_ns |
| Amend golem config file | amend_golem_config |
| Is the app in dev mode or prod mode? | app_dev app_prod |
| Insert an hidden browser button | browser_button |
| Automatically serve golem external resources | bundle_resources |
| Functions already made dev dependent | browser_dev cat_dev message_dev print_dev warning_dev |
| Create a package for a Shiny App using '{golem}' | create_golem |
| Detach all attached package | detach_all_attached |
| Disabling Shiny Autoload of R Scripts | disable_autoload |
| Document and reload your package | document_and_reload |
| Test helpers | expect_html_equal expect_running expect_shinytag expect_shinytaglist |
| Golem Function Template | fct_template |
| Fill your 'DESCRIPTION' file | fill_desc |
| Return path to the '{golem}' config-file | get_current_config |
| Get all or one golem options | get_golem_options |
| '{golem}' options | get_golem_name get_golem_version get_golem_wd set_golem_name set_golem_options set_golem_version set_golem_wd |
| A package for building Shiny App | golem-package golem |
| Welcome Page | golem_welcome_page |
| Install '{golem}' dev dependencies | install_dev_deps |
| Is the directory a golem-based app? | is_golem |
| Is the running app a golem app? | is_running |
| Golem's default custom templates | css_template empty_template js_handler_template js_template sass_template |
| maintenance_page | maintenance_page |
| Make a function dependent to dev mode | make_dev |
| Golem Module Template Function | module_template |
| Package tools | pkg_name pkg_path pkg_version |
| Project Hook | project_hook |
| Run the 'dev/run_dev.R' file | run_dev |
| Sanity check for R files in the project | sanity_check |
| Add Agent Skills to a golem Project | use_agent_skills |
| Add Claude Skills to a golem Project | use_claude_skills |
| Use Files | use_bundled_html use_external_css_file use_external_file use_external_html_template use_external_js_file use_internal_css_file use_internal_file use_internal_html_template use_internal_js_file |
| Add a favicon to your shinyapp | favicon remove_favicon use_favicon |
| Add a test file for a module | use_module_test |
| Generate a README.Rmd | use_readme_rmd |
| Add recommended elements | use_recommended_tests |
| Add a Single Skill to Installed Agent Specifications | use_skill |
| Add Skills to a golem Project | use_skills |
| Use the utils files | use_utils_server use_utils_test_server use_utils_test_ui use_utils_ui |
| Add Golem options to a Shiny App | with_golem_options |
