https://github.com/hrbrmstr/reefr-template

🧪 🕸️ 🪴 Markdown-enabled Lightweight Reactive Environment for WebR Apps
https://github.com/hrbrmstr/reefr-template

d3 markdown-it r reef reefjs rstats wasm webr webr-experiment

Last synced: about 2 months ago
JSON representation

🧪 🕸️ 🪴 Markdown-enabled Lightweight Reactive Environment for WebR Apps

• Host: GitHub
• URL: https://github.com/hrbrmstr/reefr-template
• Owner: hrbrmstr
• License: mit
• Created: 2023-03-19T19:20:12.000Z (over 1 year ago)
• Default Branch: batman
• Last Pushed: 2023-03-20T10:23:24.000Z (over 1 year ago)
• Last Synced: 2024-06-13T00:34:45.926Z (3 months ago)
• Topics: d3, markdown-it, r, reef, reefjs, rstats, wasm, webr, webr-experiment
• Language: JavaScript
• Homepage: https://rud.is/w/reefr-template/
• Size: 85 KB
• Stars: 7
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# ReefR Template

This is a bare-bones template repo for the "ReefR" WebR + Reef + d3 "framework" I'm hacking on. It is subject to wild changes. But, the main branch should always work out of the box.

I'll be adding helpers that are useful to me, which may be useful to others.

Check out the live example: .

The GH Pages version works as well, just a bit slower: .

### What is ReefR

It is a _lightweight_ alternative to Shiny and React that uses [Reef](https://reefjs.com/) and D3 + VanillaJS and WebR to help you make data-driven, reactive apps.

It also comes with a bare-bones syntax hilighter ([microlight](https://asvd.github.io/microlight/)).

One core feature I wanted was the ability to use markdown instead of just HTML, so the only thing `index.html` has is header stuff and a load of `main.js` which does all the work.

Part of that work is to render `index.md` into the DOM, which starts the app.

You edit in markdown, using HTML only when needed (i.e., where you want reactive inputs/outputs). It renders _superfast_, so have no fears about slowness.

I usually use my own install of WebR but this uses the r-wasm hosted WebR so it should work everywhere, provided you update `SW_URL` in `main.js`.

### What do I do next?

In all deployments you need to:

- fork this repo OR

```

mkdir somedir && \

  cd somedir && \

	curl -SL \

	$(curl -s https://api.github.com/repos/hrbrmstr/reefr-template/releases/latest | jq -r '.tarball_url') | tar -xvz --strip-components=1`

```

- remove the git history (if you forked it)

- start new git history

- modify `SW_URL` in `main.js` to point to the full path from `/` to the this directory

- remember to update the OG tags!

For GitHub:

- tell GitHub that `/` in your main branch is where you want GH pages to be served from

- you did update `SW_URL` in `main.js` right?

NOTE: If the indicator in the message is not a 🔵, then it is likely a 🌕 indicating it's not cross-origin isolated and some ops may be slower than ideal (this will likely happen in GH Pages deploys).

### Start hacking!