Skip to content

Commit

Permalink
doc: README
Browse files Browse the repository at this point in the history
  • Loading branch information
ColinFay committed Sep 16, 2022
1 parent 897a011 commit 1c6f9e5
Show file tree
Hide file tree
Showing 2 changed files with 159 additions and 157 deletions.
13 changes: 9 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ add_get(
fs::dir_tree(path_pipo)
```

The YALML is automatically updated:

```{r, echo=FALSE}
cat_mariobox_yaml(path_pipo)
```
Expand All @@ -133,6 +135,8 @@ remove_endpoint(
fs::dir_tree(path_pipo)
```

The YALML is automatically updated:

```{r, echo=FALSE}
cat_mariobox_yaml(path_pipo)
```
Expand Down Expand Up @@ -162,10 +166,9 @@ That way, you can handle the data manipulation function just like a plain standa

## Running the API

In dev, you can launch the file at dev/run_dev.R. Note that `golem::run_dev()` will also launch this file:

In dev, you can launch the file at dev/run_dev.R.
```{r eval = FALSE}
golem::run_dev()
source("dev/run_dev.R", echo = TRUE)
```

In production, the `run_api()` is in charge of running the API.
Expand All @@ -176,7 +179,9 @@ If you want to deloy to RStudio Connect, the `build_plumber_file()` function wil
build_plumber_file(pkg = path_pipo)
```

```{r}
This will produce the following file:

```{r echo = FALSE}
readLines(
file.path(
path_pipo,
Expand Down
Loading

0 comments on commit 1c6f9e5

Please sign in to comment.