ThinkR-open / golem

A Framework for Building Robust Shiny Apps
https://thinkr-open.github.io/golem/
Other
904 stars 132 forks source link

Update "dev/02_dev.R" #394

Closed statnmap closed 3 years ago

statnmap commented 4 years ago

Dev history file during development may benefit in following book recommendations: Engineering Production-Grade Shiny Apps

# Building a Prod-Ready, Robust Shiny Application.
# 
# Each step is optional. 
# 

# 2. Documentation and functions
## 2.1 Document and add dependencies
usethis::use_pipe()
attachment::att_amend_desc() # To call each time you update oxygen documentation, vignettes or tests
# usethis::use_package( "thinkr" ) # To call each time you need a new package

## 2.2 Vignette
usethis::use_vignette("aa_tutorial")
usethis::use_vignette("ab_read_data")
devtools::build_vignettes()

## 2.3 R-scripts
usethis::use_r("draw_map")

## 2.4 Add tests
usethis::use_test( "app" )

## 2.5 Check the package
devtools::check()

## 2.6 Code coverage
## You'll need GitHub there
usethis::use_github()
usethis::use_travis()
usethis::use_appveyor()
# tic::use_tic()

# 3. UI then
## 3.1 Add modules
golem::add_module( name = "show_map" ) # Name of the module
golem::add_module("show_map_graph")
golem::add_module("show_map_graph_datamap")
golem::add_module("show_map_graph_datamap_linkhist")

## 3.2 Add a browser button
golem::browser_button()

## 3.3 Add external files
golem::add_js_file( "script" )
golem::add_js_handler( "handlers" )
golem::add_css_file( "custom" )

# You're now set! 
# go to dev/03_deploy.R
rstudioapi::navigateToFile("dev/03_deploy.R")
ColinFay commented 3 years ago

We'll keep it simple for now, with the current process :)