Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ElMassimo/vite_ruby
⚡️ Vite.js in Ruby, bringing joy to your JavaScript experience
https://github.com/ElMassimo/vite_ruby
frontend-tooling hanami integration plugin rack rails ruby vite vitejs
Last synced: about 2 months ago
JSON representation
⚡️ Vite.js in Ruby, bringing joy to your JavaScript experience
- Host: GitHub
- URL: https://github.com/ElMassimo/vite_ruby
- Owner: ElMassimo
- License: mit
- Created: 2021-01-19T03:50:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T22:33:25.000Z (5 months ago)
- Last Synced: 2024-05-03T07:12:35.708Z (5 months ago)
- Topics: frontend-tooling, hanami, integration, plugin, rack, rails, ruby, vite, vitejs
- Language: Ruby
- Homepage: https://vite-ruby.netlify.app/
- Size: 2.87 MB
- Stars: 1,157
- Watchers: 10
- Forks: 103
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- fucking-awesome-vite - Vite Ruby - Integration for Rails, Hanami, Padrino, and Rack apps. (Integrations with Backends / Ruby on Rails)
- awesome-vite - Vite Ruby - Integration for Rails, Hanami, Padrino, and Rack apps. (Integrations with Backends / Ruby on Rails)
README
[website]: https://vite-ruby.netlify.app/
[configuration reference]: https://vite-ruby.netlify.app/config/
[features]: https://vite-ruby.netlify.app/guide/introduction.html
[guides]: https://vite-ruby.netlify.app/guide/
[config]: https://vite-ruby.netlify.app/config/
[webpacker]: https://github.com/rails/webpacker
[vite]: http://vitejs.dev/
[config file]: https://github.com/ElMassimo/vite_ruby/blob/main/vite-plugin-ruby/default.vite.json
[example app]: https://github.com/ElMassimo/pingcrm-vite
[heroku]: https://pingcrm-vite.herokuapp.com/
[Issues]: https://github.com/ElMassimo/vite_ruby/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
[Discussions]: https://github.com/ElMassimo/vite_ruby/discussions
[vite_rails]: https://github.com/ElMassimo/vite_ruby/tree/main/vite_rails
[vite_ruby]: https://github.com/ElMassimo/vite_ruby/tree/main/vite_ruby
[vite_hanami]: https://github.com/ElMassimo/vite_ruby/tree/main/vite_hanami
[no bundling]: https://vitejs.dev/guide/why.html#the-problems
[bundling]: https://vitejs.dev/guide/why.html#slow-updates
[Vite] is to frontend tooling as Ruby to programming, pure joy! 😍
This repo contains libraries that will allow you to easily integrate Vite in
your favourite Ruby framework, such as [Rails][vite_rails] or [Hanami][vite_hanami].
## Why Vite? 🤔
Vite [does not bundle your code during development][no bundling], which means the
dev server is extremely __fast to start__, and your changes will be __updated instantly__.
In production, Vite [bundles your code][bundling]
with tree-shaking, lazy-loading, and common chunk splitting out of the box, to achieve optimal loading performance.
It also provides great defaults, and is easier to configure than similar tools like webpack.
## Features ⚡️
- 💡 Instant server start
- ⚡️ Blazing fast hot reload
- 🚀 Zero-config deployments
- 🤝 Integrated with assets:precompile
- [And more!][features]
## Documentation 📖
Visit the [documentation website][website] to check out the [guides] and searchable [configuration reference].
## Installation 💿
Add this line to your application's Gemfile:
```ruby
gem 'vite_rails' # vite_hanami for Hanami apps, vite_ruby for Rack apps
```
Then, run:
```bash
bundle install
bundle exec vite install
```
This will generate configuration files and a sample setup.
Additional installation instructions are available in the [documentation website][website].
## Getting Started 💻
Restart your web server, and then run bin/vite dev to start the Vite development server.
Visit any page and you should see a printed console output: `Vite ⚡️ Ruby`.
For more [guides] and a full [configuration reference], check the [documentation website][website].
## Contact ✉️
Please use [Issues] to report bugs you find, and [Discussions] to make feature requests or get help.
Don't hesitate to _⭐️ star the project_ if you find it useful!
Using it in production? Always love to hear about it! 😃
## Special Thanks 🙏
- [webpacker]
- [vite]
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).