๐Ÿ’Ž Rails gem with the power of Vue.js components
Switch branches/tags
Nothing to show
Clone or download
ytbryan Remove the link to handbook
To be released when the Vue on Rails book is out https://vueonrails.com
Latest commit 761055f Dec 10, 2018

README.md

Welcome to Vue on Rails ๐Ÿ’Ž

Vue for your favorite Rails projects

The Vue on Rails gem makes it easy to build Vue components on your Rails application.

It uses Rails 5.x, Vue 2.x, Webpacker 3.x, Ruby 2.x, Node 11.x, Yarn 1.12.x.

  • ๐Ÿ’Ž Compatible with Rails 6/5/4 and Webpacker
  • ๐ŸŒŽ Internationalization for component parts
  • ๐Ÿ–– Vue UI ready
  • ๐Ÿ”จ Component generators and scaffolds
  • ๐Ÿ“ฆ Out of the box configuration
  • โœ‚๏ธ Specific-page Vue
  • ๐Ÿคก Jest test ready
  • ๐ŸŽฏ Simple state management
  • ๐Ÿ—ƒ Easily migrate to Vuex state management
  • ๐Ÿ‘ท๐Ÿป๏ธ Asset pipeline helpers
  • ๐ŸŽ Kickstart with our Vue on Rails application template at https://vueonrails.com/vue

It ships out-of-the-box configuration, component generators and other solutions to make life easy for both Vue and Rails.


Getting Started

Create an empty Vue on Rails project by running with an application template:

rails new app -m https://vueonrails.com/vue -d postgresql

To browse the application template, it's here https://vueonrails.com/vue

Manual Installation

Create a Rails app with vue and webpack support.

rails new app --webpack=vue -d postgresql

Add this line to your application's Gemfile and run bundle

gem 'vueonrails'

note: vuejs gem was renamed to vueonrails

and run rails vue:setup to complete the installation


Getting Help & Contributing Back

Feel free to contribute back to Vue on Rails via pull requests. Below are some links that you may find useful.


Contact

๐Ÿ“ฎ Bryan Lim ytbryan@gmail.com

Richard LaFranchi and I are writing a book Vue on Rails. If you are interested to be one of the early reviewers of our drafts, please email me.


MIT License

MIT