Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/richardvenneman/trestle-active_storage
⛩ ActiveStorage integration plugin for the Trestle admin framework
https://github.com/richardvenneman/trestle-active_storage
rails ruby trestle
Last synced: 3 months ago
JSON representation
⛩ ActiveStorage integration plugin for the Trestle admin framework
- Host: GitHub
- URL: https://github.com/richardvenneman/trestle-active_storage
- Owner: richardvenneman
- License: mit
- Created: 2017-09-15T10:49:04.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-07T15:55:41.000Z (9 months ago)
- Last Synced: 2024-07-20T00:57:36.965Z (4 months ago)
- Topics: rails, ruby, trestle
- Language: Ruby
- Homepage:
- Size: 140 KB
- Stars: 29
- Watchers: 4
- Forks: 36
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Trestle Active Storage Integration (trestle-active_storage)
> [Active Storage](https://guides.rubyonrails.org/active_storage_overview.html) integration plugin for the [Trestle admin framework](https://trestle.io)
[](https://rubygems.org/gems/trestle-active_storage)
## Usage
Define the active storage fields in your Trestle resource and use the `active_storage_field` field type:
```ruby
Trestle.resource(:users) do
active_storage_fields do
[:avatar, :profile_picture]
end
form do |user|
text_field :first_name
text_field :last_name
active_storage_field :avatar
active_storage_field :profile_picture
end
end
```
You can use the `active_storage_field` field type for both `has_one_attached` and `has_many_attached` attachments.
## Installation
These instructions assume you have a working Trestle application. To integrate trestle-active_storage, first add it to your application's Gemfile:
```ruby
gem 'trestle-active_storage'
```
Run `bundle install`, and then restart your Rails server.
### Active Storage previews
This plugin shows previews of uploaded files if your system meets the requirements. For more information please [consult the Ruby on Rails guides](https://edgeguides.rubyonrails.org/active_storage_overview.html#previewing-files).
If you'd like to get up and running on Heroku, check out their [documentation on Active Storage on Heroku](https://devcenter.heroku.com/articles/active-storage-on-heroku#attachment-previews). The [Ruby on Rails Development Dependencies Install guide](https://edgeguides.rubyonrails.org/development_dependencies_install.html#active-storage-setup) outlines how to install the neccessary dependencies to get previews working locally.
## TODO / Wishlist
- [x] Support for `has_many_attached` attachments
- [x] Support for Active Storage previews
- [ ] Preview of selected local file ([#1](https://github.com/richardvenneman/trestle-active_storage/issues/1))
- [ ] Integration tests
## Contributors
Thanks goes out to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Richard Venneman
🤔 💻 📖 💬 👀
Aboobacker MK
🤔
Rafael Porto
💻
Tom Hoen
🐛 💻
Bashar Abdullah
🐛
Emanuele Barban
💻
Oleg Kiviljov
🐛 💻
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).