Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 959 Bytes

DEVELOPMENT.md

File metadata and controls

59 lines (45 loc) · 959 Bytes
Raw

How to start developing DXOpal

Prerequisites

  • Ruby (tested with 2.5.1)
  • Node.js (to minify .js)

Setup

$ git clone https://github.com/yhara/dxopal
$ cd dxopal
$ bundle install
$ npm install uglify-es -g
$ bundle exec rackup
$ open http://localhost:9292/

Developing dxopal-starter-kit:

$ cd dxopal  # Must be cloned into here
$ git clone https://github.com/yhara/dxopal-starter-kit

Build .js

$ rake build
$ rake build_min  # Build and minify

(If some error is printed by build_min, make sure you have installed uglify-es)

Documents

Build API reference:

$ rake api

Directory structure

  • build/ : Pre-compiled source code
    • dxopal.js
    • dxopal.min.js
  • doc/
    • api/
    • en/
    • ja/
  • examples/
  • exe/
    • dxopal
  • opal/ : Source code
    • dxopal.rb
    • dxopal/
  • template/ : Template files for dxopal init command
    • index.html
    • main.rb
  • vendor/
    • matter.js
    • pages-themes-dinky-14e8031/