knitr::opts_chunk$set( collapse = TRUE, eval = TRUE, comment = "#>", fig.path = "man/figures/README-", out.width = "100%", fig.align = "center" )
name_branch <- gert::git_branch() link_to_branch_svg <- paste0( "https://codecov.io/gh/ThinkR-open/golem/branch/", name_branch, "/graph/badge.svg" ) link_to_branch_html <- paste0( "https://app.codecov.io/github/ThinkR-open/golem/tree/", name_branch )
cat('[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)') cat('[![R-CMD-check](https://github.com/ThinkR-open/golem/workflows/R-CMD-check/badge.svg)](https://github.com/ThinkR-open/golem/actions)') cat(paste0("\n[![Coverage status](", link_to_branch_svg, ")](", link_to_branch_html, ")")) cat('[![CRAN status](https://www.r-pkg.org/badges/version/golem)](https://cran.r-project.org/package=golem)')
You're reading the doc about version:
r pkgload::pkg_version()
. Note that{golem}
follows the semantic versioning scheme.
Production-grade {shiny}
applications, from creation to deployment.
{golem}
is an opinionated framework that sets the standard for building production-grade {shiny}
applications. It provides a structured environment that enforces best practices, fosters maintainability, and ensures your applications are reliable, and ready for deployment in real-world environments.
With {golem}
, developers can focus on creating high-quality, robust {shiny}
apps with confidence, knowing that the framework guides them through every step of the development process.
install.packages("golem")
# install.packages("remotes") remotes::install_github("Thinkr-open/golem") # Stable development version # remotes::install_github("Thinkr-open/golem@dev") # Bleeding edge development version
Create a new app with the project template from RStudio:
knitr::include_graphics("https://raw.githubusercontent.com/ThinkR-open/golem/master/inst/img/golemtemplate.png")
Or use the golem::create_golem()
function:
golem::create_golem("myapp")
See your app in action by running golem::run_dev()
function.
Then, follow the scripts at:
dev/01_start.R
to configure your project at launchdev/02_dev.R
for day to day developmentdev/03_deploy.R
to build the deployment enabler for your appThe {golem}
package is part of the {golemverse}
, a series of tools for building production {shiny}
apps.
A list of various {golem}
related resources (tutorials, video, blog post,...) can be found here, along with blogposts, and links to other packages of the golemverse
.
This README
has been compiled on the
Sys.time()
Here are the test & coverage results:
devtools::check(quiet = TRUE)
unloadNamespace("golem")
Sys.setenv("NOT_CRAN" = TRUE);covr::package_coverage()
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.
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() })
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.