Skip to content

Commit d310b50

Browse files
authored
Merge pull request #44 from curso-r/ui-server
Ui server
2 parents 6f79a10 + e172412 commit d310b50

32 files changed

+413
-99
lines changed

.Rbuildignore

+1
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@
1010
^appveyor\.yml$
1111
^docs$
1212
^cran-comments\.md$
13+
^vignette/examples$

NEWS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
- Export `auth0_find_config_file()`, `auth0_config()` and `auth0_info()` functions to ease debugging.
66

77
# auth0 0.1.2
8-
8+
99
- Add `auth0_credentials` to user session data (Issue #39).
1010
- (breaking change) change `login_info` to `auth0_info` in the user session data (Issue #19).
1111
- Option to ignore auth0 and work as a normal shiny app, to save developing time (Issue #26).

README.md

+17-20
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
[![Travis-CI Build Status](https://travis-ci.org/curso-r/auth0.svg?branch=master)](https://travis-ci.org/curso-r/auth0) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/curso-r/auth0?branch=master&svg=true)](https://ci.appveyor.com/project/curso-r/auth0) [![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/auth0)](https://cran.r-project.org/package=auth0)
44

5-
The goal of `{auth0}` is to implement an authentication scheme to Shiny using
6-
OAuth Apps through the freemium service [Auth0](https://auth0.com).
5+
The goal of `{auth0}` is to implement an authentication scheme to Shiny using OAuth Apps through the freemium service [Auth0](https://auth0.com).
76

87
## Installation
98

@@ -17,10 +16,10 @@ You can also install the development version from github with:
1716

1817
``` r
1918
# install.packages("devtools")
20-
devtools::install_github("curso-r/auth0")
19+
remotes::install_github("curso-r/auth0")
2120
```
2221

23-
## Auth0 Configuration
22+
## Tutorial
2423

2524
To create your authenticated shiny app, you need to follow the five steps below.
2625

@@ -112,12 +111,7 @@ server <- function(input, output, session) {
112111
# note that here we're using a different version of shinyApp!
113112
auth0::shinyAppAuth0(ui, server)
114113
```
115-
116-
**Note**: If you want to use a different path to the `auth0` configuration file, you can
117-
either pass it to `shinyAppAuth0()` or
118-
set the `auth0_config_file` option by running `options(auth0_config_file = "path/to/file")`.
119-
120-
Also note that currently Shiny apps that use the 2-file approach (`ui.R` and `server.R`) are not supported. Your app must be inside a single `app.R` file.
114+
**Note**: If you want to use a different path to the `auth0` configuration file, you can either pass it to `shinyAppAuth0()` or set the `auth0_config_file` option by running `options(auth0_config_file = "path/to/file")`.
121115

122116
### Step 5: Run!
123117

@@ -182,7 +176,7 @@ library(auth0)
182176
auth0_server(function(input, output, session) {})
183177
```
184178

185-
`{auth0}` will try to find the `_auth0.yml` using the same strategy than the `app.R` framework: first from `options(auth0_config_file = "path/to/file")` and then fixing `"./_auth0.yml"`. Both `auth0_ui()` and `auth0_server()` have a `info=` parameter where you can pass either the path of the `_auth0.yml` file or the
179+
`{auth0}` will try to find the `_auth0.yml` using the same strategy than the `app.R` framework: first from `options(auth0_config_file = "path/to/file")` and then fixing `"./_auth0.yml"`. Both `auth0_ui()` and `auth0_server()` have a `info=` parameter where you can pass either the path of the `_auth0.yml` file or the object returned by `auth0_info()` function.
186180

187181

188182
--------------------------------------------------------------------------------
@@ -317,7 +311,7 @@ shinyAppAuth0(ui, server)
317311

318312
## Costs
319313

320-
Auth0 is a freemium service. The free account lets you have up to 1000 connections in one month and two types of social connections. You can check all the plans [here](https://auth0.com/pricing).
314+
Auth0 is a freemium service. The free account lets you have up to 7000 connections in one month and two types of social connections. You can check all the plans [here](https://auth0.com/pricing).
321315

322316
## Disclaimer
323317

@@ -327,14 +321,17 @@ This package is not provided nor endorsed by Auth0 Inc. Use it at your own risk.
327321

328322
## Roadmap
329323

330-
- `{auth0}` 0.2.0
331-
- [X] Remove the need for local and remote URLs in the `config_file`.
332-
- [X] Solve bookmarking and URL parameters issue (Issue #22).
333-
- [x] `shinyAppDirAuth0()` function to work as `shiny::shinyAppDir()` (Issue #21).
334-
- [x] Support to `ui.R`/`server.R` apps.
335-
- `{auth0}` 0.3.0
336-
- [ ] Implement `{auth0}` API functions to manage users and login options throusgh R.
337-
- [ ] Hex sticker.
324+
### `{auth0}` 0.2.0
325+
326+
- [] Remove the need for local and remote URLs in the `config_file`.
327+
- [] Solve bookmarking and URL parameters issue (Issue #22).
328+
- [] `shinyAppDirAuth0()` function to work as `shiny::shinyAppDir()` (Issue #21).
329+
- [] Support to `ui.R`/`server.R` apps.
330+
331+
### `{auth0}` 0.3.0
332+
333+
- [ ] Implement `{auth0}` API functions to manage users and login options throusgh R.
334+
- [ ] Hex sticker.
338335

339336
--------------------------------------------------------------------------------
340337

_pkgdown.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
template:
2+
params:
3+
bootswatch: united

docs/404.html

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/LICENSE-text.html

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/articles/examples/bookmark.html

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/articles/examples/logout.html

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/articles/examples/simple.html

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/articles/examples/ui-server-bookmark.html

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/articles/examples/ui-server.html

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)