Skip to content

Commit 3ee4517

Browse files
committed
doc: readme points to deploy vignette for deployment info
1 parent 50435c3 commit 3ee4517

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ To do this either:
160160
next section); or
161161
- copy the contents of that directory into `inst/app/www/data/` and re-install {tfpbrowser}
162162

163-
## Configuring the app
163+
### Configuring the app
164164

165165
Data presented by the app can be obtained from an arbitrary directory on the server.
166166
To configure the data-directory, use the environment variable `APP_DATA_DIR`.
@@ -182,3 +182,22 @@ run_app()
182182

183183
An alternative way to specify this data directory is to add the line
184184
`APP_DATA_DIR="/home/me/tfpdata/"` to a `.Renviron` file in the project root.
185+
186+
## Deploying the app
187+
188+
Please see the vignette `deploy` in {tfpbrowser} which provides a walk-through for deploying to
189+
[shinyapps.io](https://www.shinyapps.io/). This is in `./vignettes/deploy.Rmd` in the {tfpbrowser}
190+
repository.
191+
192+
If working in the tfpbrowser repository, developers may need to build the vignettes:
193+
194+
```r
195+
# Build the vignette (Optional, if you haven't installed tfpbrowser)
196+
# In the repository for {tfpbrowser}
197+
devtools::build_vignettes()
198+
pkgload::load_all()
199+
200+
# View the vignette
201+
vignette("deploy", package = "tfpbrowser")
202+
```
203+

0 commit comments

Comments
 (0)