[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/
[vite_rails]: https://github.com/ElMassimo/vite_ruby/tree/main/vite_rails
[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
[no bundling]: https://vitejs.dev/guide/why.html#the-problems
[bundling]: https://vitejs.dev/guide/why.html#why-bundle-for-production
[Vite] is to frontend tooling as Ruby to programming, pure joy! 😍
[__Vite Rails__][vite_rails] provides a complete setup for Rails applications,
allowing you to leverage [Vite] to power the frontend of your Rails app.
## 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.
Check [this video comparison with webpack](https://github.com/ElMassimo/jumpstart-vite)
which demonstrates the difference in boot time, or [this one](https://github.com/ElMassimo/pingcrm-vite/pull/1)
with the difference in speed during development.
## 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_rails_legacy if using Rails 4
```
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 Rails 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).
