Skip to content
master
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
app
 
 
bin
 
 
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

vue on rails

Vue for your favorite Rails products

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

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

  • ๐Ÿ–– Vue UI ready
  • ๐Ÿถ Support pug
  • ๐Ÿคก Jest test ready
  • โœ‚๏ธ Specific-page Vue
  • ๐Ÿ‘ท๐Ÿป๏ธ Asset pipeline helpers
  • ๐ŸŽฏ Simple state management
  • ๐Ÿ“ฆ Out of the box configuration
  • ๐Ÿ”จ Component generators and scaffolds
  • โ„๏ธ Server Side Rendering using Hypernova
  • ๐Ÿ—ƒ Easily migrate to Vuex state management
  • ๐ŸŒŽ Internationalization for component parts
  • ๐Ÿ’Ž Compatible with Rails 6/5/4 and Webpacker
  • ๐ŸŽ Kickstart with our 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

You canโ€™t perform that action at this time.