rink-rs/web
Tiffany Bennett a13b9fcbaf
Markup for doc strings (#177)
Makes Rink parse out the links and date strings when using the token
format machinery. This is a new syntax in the definitions file with
`<abc>` for links and `#abc#` for dates.

Replaced ansi_term with nu-ansi-term because the former was
unmaintained. The latter comes with the ability to set hyperlinks.
2024-05-27 16:51:42 -07:00
..
currency v0.8.0 2024-04-20 19:35:30 -07:00
plugins Website bugfixes (#171) 2024-05-04 15:23:30 -07:00
repl Markup for doc strings (#177) 2024-05-27 16:51:42 -07:00
scripts Rink-web 3 (#165) 2024-04-20 18:46:50 -07:00
site Website bugfixes (#171) 2024-05-04 15:23:30 -07:00
templates Rink-web 3 (#165) 2024-04-20 18:46:50 -07:00
package-lock.json v0.8.0 2024-04-20 19:35:30 -07:00
package.json v0.8.0 2024-04-20 19:35:30 -07:00
README.adoc Rink-web 3 (#165) 2024-04-20 18:46:50 -07:00
soupault.toml Website bugfixes (#171) 2024-05-04 15:23:30 -07:00

= Rink web

This is the sources required to build https://rinkcalc.app, which is
a statically generated site.

== Requirements

* `wasm-pack` (`pacman -S wasm-pack` or cargo install)
* `cmark-gfm` (`pacman -S cmark-gfm`)
* https://soupault.app/install/[soupault]
* Node.JS (21.7.1 known to work)

== Instructions

1. Run `wasm-pack build --target web rink-js`. This only needs to be
   re-run after making changes to rust code.
2. Enter `web/repl/` and run `npm install`
3. Enter `web/` and run `npm install`
4. Enter `web/` and run `soupault --verbose`
5. Enter `web/currency/` and run `npm install`
6. Enter `web/build/` and run `node ../currency/update-currency.js`
7. To view, enter `web/build/` and run
   `python -m http.server -b localhost 3000 --protocol HTTP/1.1`

Github releases are only fetched once. To re-fetch them, delete
`web/build/releases.json` and re-run soupault.

== Deployment

Copy the contents of `web/build/` to your server.

Copy `web/currency/`, including its `node_modules`, to your server.
Setup a cron job to run the currency script to update the `data/`
directory, about once an hour is good.