installation_flat.md

Install for Cuba, Roda, Sinatra and others with a flat structure

owl-install flat

Please see the message of owl-install. You may need to manually add the following gems to the projects Gemfile:

gem 'opal', github: 'janbiedermann/opal', branch: 'es6_modules'
gem 'opal-webpack-loader', '~> 0.13.0' # use the most recent released version here

Then:

yarn install
bundle install

The installer produces a app_loader.rb which require './owl_init'. app_loader.rb is used by the compile server to correctly determine opal load paths. It should be required by config.ru. Opal ruby files should then go in the newly created opal directory. With the option -o the directory can be named differently, for example:

owl-install flat -o supersuper

A directory supersuper will be created, opal files should then go there and will be properly resolved by webpack.

Complete set of directories and files created by the installer for projects with a flat structure:

project_root
    +- owl_init.rb      # initializer for owl
    +- javascripts      # javascript entries directory
        +- application.js
        +- application_common.js
        +- application_ssr.js
        +- application_webworker.js
    +- opal             # directory for opal application files, can be changed with -o
    +- package.json     # package config for npm/yarn and their scripts
    +- public
        +- assets       # directory for compiled output files
    +- styles           # directory for stylesheets
    +- webpack          # directory for webpack configuration files
        +- debug.js
        +- development.js
        +- production.js
    +- Procfile         # config file for foreman