Skip to content

Commit 498c930

Browse files
committed
Add a few notes.
1 parent d2e8bcc commit 498c930

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

README.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,30 @@ jobs:
113113
uses: actions/deploy-pages@v2
114114
```
115115
116-
Deployment with this approach requires it to be enabled by:
116+
> [!NOTE]
117+
>
118+
> We make an assumption when exporting the Shiny app about:
119+
>
120+
> 1. the app can be found in the working directory, e.g. `.`
121+
> 2. the deployment folder is `_site`
122+
>
123+
> If this is not the case, please modified the step in the deployment recipe
124+
> that contains:
125+
>
126+
> ```r
127+
> shinylive::export(".", "_site")
128+
> ```
129+
>
130+
131+
> [!NOTE]
132+
>
133+
> The output directory of `_site` for the converted shinylive app
134+
> is used since it is the default path location for the
135+
> [`upload-pages-artifact`](https://github.com/actions/upload-pages-artifact)
136+
> action. This can be changed by supplying `path` parameter under `with` in the
137+
> "Upload Pages artifact" step.
138+
139+
Deployment through the GitHub Actions to GitHub Pages requires it to be enabled on the repository by:
117140

118141
- Clicking on the repository's **Settings** page
119142
- Selecting **Pages** on the left sidebar.
@@ -125,10 +148,9 @@ Deployment with this approach requires it to be enabled by:
125148

126149
## Working Example
127150

128-
For a comprehensive example demonstrating deployment, documentation, and a functional version of your app, refer to the following:
151+
You can view the example shinylive-ified [app.R](app.R) source included in the repository here:
129152

130-
- Repository: https://github.com/coatless-tutorials/convert-shiny-app-r-shinylive
131-
- Deployed shiny app: https://tutorials.thecoatlessprofessor.com/convert-shiny-app-r-shinylive/
153+
<https://tutorials.thecoatlessprofessor.com/convert-shiny-app-r-shinylive>
132154

133155
Some quick screenshots that describe whats up:
134156

0 commit comments

Comments
 (0)