Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kennedymwavu/ambiorix-examples
Ambiorix examples
https://github.com/kennedymwavu/ambiorix-examples
ambiorix r
Last synced: about 1 month ago
JSON representation
Ambiorix examples
- Host: GitHub
- URL: https://github.com/kennedymwavu/ambiorix-examples
- Owner: kennedymwavu
- License: gpl-3.0
- Created: 2024-01-07T21:16:02.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-28T23:07:50.000Z (about 2 months ago)
- Last Synced: 2024-07-29T00:48:02.612Z (about 2 months ago)
- Topics: ambiorix, r
- Language: R
- Homepage: https://mwavu.com/ambiorix-examples/
- Size: 1.77 MB
- Stars: 28
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - kennedymwavu/ambiorix-examples - Ambiorix examples (R)
README
## What is ambiorix?
[Ambiorix](https://ambiorix.dev/) is an unopinionated and minimalist web framework for R.
It is inspired by [express.js](https://expressjs.com/). In fact,
the syntax is almost identical, only that it is R and not JavaScript.
Ambiorix is a **server-side** or **back-end** framework. It is not
comparable to client-side frameworks like React, Angular, Vue, etc. However, it can be used in combination with those frameworks
to build full stack applications.
## "Unopinionated and Minimalist"... What does that mean?
Ambiorix does not assume you're going to build your app/API in any
certain way or using a certain design pattern. You have absolute
full control of how you handle requests to the server and
how you respond.
## So, why should I use ambiorix?
- Makes building web applications with R **VERY** easy
- Used for both server rendered apps (SSRs) as well as API/Microservices
- Full control of the request and response cycle
- Great to use with your favorite client side framework (whether React, Angular, Vue etc.)
## What exciting features can I look forward to?
Here are the features that make ambiorix well-suited to building
large systems & applications:
- Out of the box **routing**
- Creating a robust **API** is quick and easy
- Templating (HTML, markdown, pug, etc.)
- Websockets in case you need bidirectional communication
## What should I know first?
The main prerequisites are:
- having a good understanding of **R fundamentals**, and,
- basic knowledge of HTTP status codes.
You can pickup most of the concepts on the go.
## Package dependencies used in examples
Each example has been bootstrapped using [`{renv}`](https://rstudio.github.io/renv/articles/renv.html) to ease reproducibility.
To install the dependencies for a specific example eg. `05_router`:
1. Switch to its directory
```bash
cd 05_router
```
1. Add this to the `.Renviron` file:
```r
RENV_CONFIG_SANDBOX_ENABLED = FALSE
```
1. Fire up R and restore the dependencies:
```r
renv::restore()
```
## Documentation
You can find documentation on each of the examples at [mwavu.com/ambiorix-examples](https://mwavu.com/ambiorix-examples/).
The documentation includes:
- how to run each example
- code and concept explanations where necessary
## Note
In some of the examples I've committed the `.Renviron` files. I did this just to make it easier for you to run the examples.
However, you should **NEVER** commit a file that has any type of credentials (`.Renviron` in this case). Such files should always be included in your `.gitignore` so that git doesn't track them.