Funicular

🎵Funicu-lì, Funicu-là!🚊🚊🚊

🎵Funicu-lì, Funicu-là!🚞🚞🚞

Funicular is a single-page application (SPA) framework powered by PicoRuby.wasm.

Features

Write client-side code in Ruby instead of JavaScript
Seamless Rails integration

Combined Gem

This repository consists of three relevant projects:

PicoGem "picoruby-funicular" ... Core implementation
CRubyGem "funicular" ... Rails integration
Chrome extension "PicoRuby Debugger"

PicoGem "picoruby-funicular"

.
├── mrbgem.rake
├── mrblib/
└── test/

CRubyGem "funicular"

.
├── bin/
├── exe/
├── funicular.gemspec
├── Gemfile
├── Gemfile.lock
├── lib/
├── minitest/
└── Rakefile

Chrome extention "PicoRuby.wasm debugger"

.
└── debugger/

The others are common resources.

Documentation

You may want to see Tic-Tac-Toe tutorial first: https://picoruby.org/funicular

Then, dig docs/.

Development

This repository is a submodule of picoruby/picoruby. Do not check it out standalone. Instead, clone the parent repository and work from there:

git clone --recurse-submodules https://github.com/picoruby/picoruby.git
cd picoruby/mrbgems/picoruby-funicular

The CRubyGem side (lib/, funicular.gemspec, etc.) can be developed and tested independently inside that directory, but rake copy_wasm — which vendorsthe PicoRuby.wasm and picorbc wasm artifacts into the gem — relies on sibling directories within the picoruby repository (mrbgems/picoruby-wasm/npm/). Running it from a standalone checkout will fail.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/picoruby/funicular.