Purpose
To provide an upgrade path for those looking to retain the features of rails-ujs, but using a currently maintained library written in Typescript and using modern features like MutationObservers and fetch.
Check out the docs
The official docs can be found here:
Working on mrujs locally
- Clone the repo
git clone https://github.com/ParamagicDev/mrujs
cd mrujs
- Install packages
pnpm install
View Dev Server
pnpm run start
Run tests
pnpm test
Rails
There is also a Rails dummy app attached in this repo for testing.
Installation
Top level:
bundle install
Starting
Must be run within the test/rails/dummy
directory.
cd test/rails/dummy && bundle exec rails server
Tests
From any where outside of the test/rails/dummy
directory:
bundle exec rake test
Docs
Docs are located in /docs
and use Bridgetown + Netlify.
To start the docs server do the following:
cd docs && bundle install && bin/bridgetown start