forked from ThinkR-open/golem
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
113 lines (72 loc) · 4 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
eval = FALSE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%",
fig.align = "center"
)
```
[](https://www.tidyverse.org/lifecycle/#maturing)
[](https://travis-ci.org/ThinkR-open/golem)
[](https://ci.appveyor.com/project/ThinkR-open/golem)
[](https://codecov.io/github/ThinkR-open/golem?branch=master)
[](https://cran.r-project.org/package=golem)
<img src="https://raw.githubusercontent.com/ThinkR-open/golem/master/inst/rstudio/templates/project/golem.png" width=250px>
# {golem}
`{golem}` is an opinionated framework for building production-grade shiny applications.
## 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://thinkr-open.github.io/building-shiny-apps-workflow/>
### Blog posts :
_Building Big Shiny Apps_
- Part 1: <https://rtask.thinkr.fr/blog/building-big-shiny-apps-a-workflow-1/>
- Part 2: <https://rtask.thinkr.fr/blog/building-big-shiny-apps-a-workflow-2/>
### Slide decks
- useR! 2019 : [A Framework for Building Robust & Production Ready Shiny Apps](https://github.com/VincentGuyader/user2019/raw/master/golem_Vincent_Guyader_USER!2019.pdf)
- ThinkR x RStudio Roadshow,Paris : [Production-grade Shiny Apps with {golem}](https://speakerdeck.com/colinfay/production-grade-shiny-apps-with-golem)
### Video
- [{golem} and Effective Shiny Development Methods](https://www.youtube.com/watch?v=OU1-CkSVdTI)
- [Hands-on demonstration of {golem}](https://shinydevseries.com/post/golem-demo/)
- useR! 2019 : [A Framework for Building Robust & Production Ready Shiny Apps](https://youtu.be/tCAan6smrjs)
### Cheatsheet
- [{golem} cheatsheet](https://thinkr.fr/golem_cheatsheet_v0.1.pdf)
## Installation
+ You can install the stable version from CRAN with:
``` r
install.packages("golem")
```
+ You can install the development version from [GitHub](https://github.com/Thinkr-open/golem) with:
``` r
# install.packages("remotes")
remotes::install_github("Thinkr-open/golem")
```
## Launch the project
Create a new package with the project template:
```{r, echo=FALSE, out.width="80%", eval=TRUE}
knitr::include_graphics("https://raw.githubusercontent.com/ThinkR-open/golem/master/inst/img/golemtemplate.png")
```
## Step by step guide
See full documentation in the {pkgdown} website: <https://thinkr-open.github.io/golem/index.html>
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](https://thinkr-open.github.io/golem/articles/a_start.html) Vignette for a detailed walkthrough.
### Step 2 : Day to Day Dev
Read [Day to Day Dev](https://thinkr-open.github.io/golem/articles/b_dev.html) Vignette for a detailed walkthrough.
### Step 3: deploy
Read [Deploying Apps with {golem}](https://thinkr-open.github.io/golem/articles/c_deploy.html) Vignette for a detailed walkthrough.
## CoC
Please note that this project is released with a [Contributor Code of Conduct](https://www.contributor-covenant.org/version/1/0/0/code-of-conduct.html).
By participating in this project you agree to abide by its terms.