You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 19, 2018. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+22-18Lines changed: 22 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,5 @@
1
1
# Hyperloop JS
2
2
3
-
TODO: Docs about router
4
-
5
3
### Hyperloop.js
6
4
7
5
Hyperloop client-side including:
@@ -22,9 +20,9 @@ Compiles code in your browser. Client-side Hyperloop and Opal for static sites o
22
20
+ You can work with Hyperloop Components, Stores, Operations and HyperRouter
23
21
+ No backend dependency or setup required
24
22
25
-
<!--### Opal.js
23
+
### Hyper-router.js
26
24
27
-
+ Latest build of Opal. Include this file or bring your own. -->
25
+
Ruby DSL wrapper of React Router V4. Requires ReactRouter and ReactRouterDOM.
28
26
29
27
## Documentation and Help
30
28
@@ -35,32 +33,38 @@ See [VERSIONS](https://github.com/ruby-hyperloop/hyperloop-js/blob/master/VERSIO
35
33
36
34
## How it works
37
35
38
-
#### Hyperloop.js
39
-
40
36
##### Front-end
41
37
42
-
Hyperloop-js includes Hyperloop's client side Components, Operations, Stores and Hyper-Router.
38
+
+ Hyperloop.js includes Hyperloop's client side Components, Operations and Stores.
39
+
+ Hyperloop-compiler.js includes Opal Compiler for compiling Ruby Hyperloop code in your browser.
40
+
+ Hyper-router includes a client-side build of the Hyper-router gem
43
41
44
-
##### Back-end
42
+
##### No back-end (compile Ruby code in your browser)
45
43
46
-
You will need a backend to build the Hyperloopcode you write.
44
+
If you do not want a backend then you can use Hyperloop-compiler.js to compile code in your browser. Your ruby code will be compiled by the browser into JavaScript and executed. Any compilation or runtime errors will be briefly reported to the console.
47
45
48
-
+ Hyperloop Gem for Rails integration
49
-
+ Opal Sprockets for Rack backend
50
-
+ Simple Opal Rake rask
51
46
52
-
See Installation options on http://ruby-hyperloop.io/
47
+
##### Back-end (compile Ruby code on the server)
53
48
54
-
##### No back-end
49
+
To compile your code server-side, you will need a backend integrated with Opal. Your choices are:
55
50
56
-
If you do not want a backend then you can use Hyperloop-compiler.js to compile code in your browser.
+ Opal Sprockets for Rack backend for a simple build process
53
+
+ Minimal Rake task to compile with Opal
54
+
+ Node.js using Webpack to compile Opal code
57
55
58
-
#### Hyperloop-Compiler.js
59
-
60
-
Your ruby code will be compiled by the browser into JavaScript and executed. Any compilation or runtime errors will be briefly reported to the console.
56
+
See all the installation options on http://ruby-hyperloop.io/
0 commit comments