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
Copy file name to clipboardExpand all lines: docs/start/100-installation/README.md
+13-5Lines changed: 13 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,6 @@
1
1
# Installation guide
2
2
3
-
This guide shows you how to add matestack-ui-core to an existing rails application.
4
-
5
-
If you want to use Matestack's optional reactivity features, please follow this [guide](/docs/reactive_components/100-rails_integration/) after performed the following steps for basic installation:
3
+
This guide shows you how to add the `matestack-ui-core` gem to an existing Rails application.
6
4
7
5
## Installation
8
6
@@ -20,12 +18,16 @@ $ bundle install
20
18
21
19
### Matestack folder
22
20
23
-
Create a folder called 'matestack' in your app directory. All your matestack apps,
21
+
Create a folder called 'matestack' in your app directory. All your Matestack apps,
24
22
pages and components will be defined there.
25
23
24
+
```shell
25
+
$ mkdir app/matestack
26
+
```
27
+
26
28
### Controller setup
27
29
28
-
Add the matestack helper to your controllers. If you want to make the helpers
30
+
Add the Matestack helper to your controllers. If you want to make the helpers
29
31
available in all controllers, add it to your 'ApplicationController' this way:
30
32
31
33
`app/controllers/application_controller.rb`
@@ -36,3 +38,9 @@ class ApplicationController < ActionController::Base
36
38
#...
37
39
end
38
40
```
41
+
42
+
### Conclusion
43
+
44
+
Now, you are able to create UI components in pure Ruby and use them in your Rails views. Additionally you can substitute Rails views and layouts with Matestack pages and apps.
45
+
46
+
If you want to use Matestack's optional reactivity features in pure Ruby (through dynamic Vue.js components such as `form` and `async` or dynamic page transitions), please follow this [guide](/docs/reactive_components/100-rails_integration/) to set up the JavaScript parts via AssetPipeline or Webpacker.
0 commit comments