Skip to content

Commit d6764c7

Browse files
committed
Document API-only and vite_rails apps in README
1 parent b38efa8 commit d6764c7

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,20 @@ And that's it. With this alone, you should be able to access Mission Control Job
3030

3131
![Failed jobs tab in a simple app](docs/images/failed-jobs-simple.png)
3232

33+
### API-only apps or apps using `vite_rails`
34+
35+
If you want to use Mission Control – Jobs with an [API-only Rails app](https://guides.rubyonrails.org/api_app.html) or an app that's using `vite_ruby`/`vite_rails`, you need just one more thing: configure an asset pipeline so you can serve the JavaScript and CSS included in this gem. We recommend to use [`propshaft`](https://github.com/rails/propshaft). You simply need to add this line to your application's Gemfile:
36+
37+
```ruby
38+
gem "propshaft"
39+
```
40+
41+
Then execute
42+
```bash
43+
$ bundle install
44+
```
45+
46+
And you should be ready to go.
3347

3448
### Authentication and base controller class
3549

0 commit comments

Comments
 (0)