dialkit-rails 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/README.md +115 -0
- data/app/assets/stylesheets/dialkit.css +1058 -0
- data/lib/dialkit/rails/engine.rb +17 -0
- data/lib/dialkit/rails/helper.rb +11 -0
- data/lib/dialkit/rails/version.rb +7 -0
- data/lib/dialkit/rails.rb +5 -0
- data/lib/generators/dialkit/install/install_generator.rb +45 -0
- data/lib/generators/dialkit/install/templates/dialkit_demo.jsx +57 -0
- data/packages/dialkit-rails/index.d.ts +1 -0
- data/packages/dialkit-rails/index.js +1 -0
- data/packages/dialkit-rails/package.json +29 -0
- data/packages/dialkit-rails/styles.css +1 -0
- metadata +87 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 930ab0f0bb4c7b57ba1cc2afa79855c97cf1c2c72eb9c5c9f1fdb56e0b946f75
|
|
4
|
+
data.tar.gz: 31d121d70bb6583d4c80afa7bd394f25ed2390b520bfb20a811095c1cabc49d5
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 9e8961cea17062c6e3fff7e3ba766c5cda401bdc48f7742ffbc7e7d9bfb6dc4ba0fb8b0bca4c4589995dde212c7b788649a0227eef0ddbd02e9d1a4e2cd8dd79
|
|
7
|
+
data.tar.gz: 74d1aa0f3c96fbf15bef2a08d7711f2840c7b8358677e3a12e768b5a01abcea071c583f6d11ddc5ad316bd663e39ef233c2f6d4fbcd7721a44923ded1815c3bb
|
data/README.md
ADDED
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# dialkit-rails
|
|
2
|
+
|
|
3
|
+
Rails integration for DialKit, built for React + Motion apps running inside Rails.
|
|
4
|
+
|
|
5
|
+
This repository contains:
|
|
6
|
+
|
|
7
|
+
- Ruby gem integration (engine + installer generator)
|
|
8
|
+
- JS wrapper package at `packages/dialkit-rails` (thin re-export of upstream `dialkit`)
|
|
9
|
+
|
|
10
|
+
## Install in a Rails app
|
|
11
|
+
|
|
12
|
+
### Option A: Install from RubyGems (after publish)
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
gem "dialkit-rails", require: "dialkit/rails"
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
### Option B: Install from Git (available now)
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
gem "dialkit-rails",
|
|
22
|
+
git: "https://github.com/alex-friedman-modo/dialkit-rails.git",
|
|
23
|
+
branch: "locate-gridkit-source",
|
|
24
|
+
require: "dialkit/rails"
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Then run:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
bundle install
|
|
31
|
+
bin/rails g dialkit:install
|
|
32
|
+
npm install dialkit-rails motion react react-dom
|
|
33
|
+
npm run build
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
The installer adds:
|
|
37
|
+
|
|
38
|
+
- `app/javascript/dialkit_demo.jsx`
|
|
39
|
+
- `import "./dialkit_demo"` in `app/javascript/application.js`
|
|
40
|
+
- `<%= dialkit_stylesheet_tag "data-turbo-track": "reload" %>` in your layout
|
|
41
|
+
|
|
42
|
+
To mount the demo panel, render:
|
|
43
|
+
|
|
44
|
+
```erb
|
|
45
|
+
<section id="dialkit-root" aria-label="DialKit demo app"></section>
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Local development (this repo)
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
bundle install
|
|
52
|
+
npm install
|
|
53
|
+
bin/dev
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Open `http://localhost:3000`.
|
|
57
|
+
|
|
58
|
+
## Release and publish
|
|
59
|
+
|
|
60
|
+
Release version must match in:
|
|
61
|
+
|
|
62
|
+
- `lib/dialkit/rails/version.rb`
|
|
63
|
+
- `packages/dialkit-rails/package.json`
|
|
64
|
+
|
|
65
|
+
### Manual publish
|
|
66
|
+
|
|
67
|
+
1. Bump both versions.
|
|
68
|
+
2. Build and verify:
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
gem build dialkit-rails.gemspec
|
|
72
|
+
ruby scripts/check_release_versions.rb
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
3. Publish the gem:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
gem signin
|
|
79
|
+
gem push dialkit-rails-<version>.gem
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
4. Publish npm package:
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
cd packages/dialkit-rails
|
|
86
|
+
npm publish --access public
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Automated publish (recommended)
|
|
90
|
+
|
|
91
|
+
Push a tag matching the version (`v0.1.0`, etc.). The release workflow publishes both artifacts.
|
|
92
|
+
|
|
93
|
+
Required GitHub secrets:
|
|
94
|
+
|
|
95
|
+
- `RUBYGEMS_API_KEY`
|
|
96
|
+
- `NPM_TOKEN`
|
|
97
|
+
|
|
98
|
+
Commands:
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
git tag v0.1.0
|
|
102
|
+
git push origin v0.1.0
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Full checklist and external app verification:
|
|
106
|
+
|
|
107
|
+
- `docs/publish-and-smoke-test.md`
|
|
108
|
+
|
|
109
|
+
## Key paths
|
|
110
|
+
|
|
111
|
+
- Gem entrypoint: `lib/dialkit/rails.rb`
|
|
112
|
+
- Engine wiring: `lib/dialkit/rails/engine.rb`
|
|
113
|
+
- Install generator: `lib/generators/dialkit/install/install_generator.rb`
|
|
114
|
+
- JS wrapper package: `packages/dialkit-rails/`
|
|
115
|
+
- Release version check: `scripts/check_release_versions.rb`
|