Vue on Rails ๐Ÿ’Ž
Switch branches/tags
Nothing to show
Clone or download
Latest commit 1fb08ac Oct 9, 2018

README.md

Welcome to Vuejs Gem ๐Ÿ’Ž

Vue for your favourite Ruby on Rails projects

This gem aims to make it easy and simple to run Vue on Rails project. It ships out-of-the-box configuration, component generators and solutions to make life easy for both Vue and Rails.


Getting Started

To create an empty Vue on Rails project, please run the following Rails command with an application template

rails new app -m http://vueonrails.com/vue

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

Manual Installation

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

gem 'vuejs'

and run rails vue:setup

You can scaffold a Vue component by reading along the Vue on Rails Handbook


Getting Help & Contributing Back

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.


Contact

๐Ÿ“ฎ Bryan Lim ytbryan@gmail.com

If you are using Vue.js via this rubygem, please let me know so that I can list your project/company on this repo. Thank you!

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

Bug reports and pull requests are welcome on GitHub at https://github.com/ytbryan/vueonrails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct. The gem is available as open source under the terms of the MIT License.