vueonrails Goto Github PK

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.

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

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

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

• Official Rails documentation

• Official Vue documentation

• Official Vue Curated components

• Vuecomponents.com

• Vuetoolbox.com

• Github search for Vue stuffs

• Stackoverflow.com

• Vue on Rails github

• On stackoverflow.com, tag your Vue on Rails questions with Vue & Rails and we will try to answer you.

• And it is likely that I missed some great online materials. If you think there is a more worthy resource, please edit this readme via a pull request.

• Find a bug? Submit an issue on our tracker.

• Find something wrong? Send a pull request.

📮 Bryan Lim [email protected]

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