rails_vue3_quasar 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +80 -3
- data/lib/rails_vue3_quasar/version.rb +1 -1
- data/rails_vue3_quasar.gemspec +3 -3
- metadata +29 -5
- data/.gitignore +0 -8
- data/CODE_OF_CONDUCT.md +0 -74
- data/Gemfile +0 -8
- data/Rakefile +0 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6f58420f5c120675b16a9c598acc910160582ad459f1d317a152842008858073
|
4
|
+
data.tar.gz: 7bf982060d529c1a98213b8cf42320d7d50602a4f527f7af66299c5086b92c19
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8ef6aba86f7ff8accfa217f5d2a5c1eff00efb9fcb34d64fec4ec50852bdce72fc20269b7eaa99665926d2172d1ba03e8a634b68c1263426e59f1566608e739f
|
7
|
+
data.tar.gz: e4a2457de2bbaa9e56785e8dab7f32c7f49ab34237a4ae6dc4549e2a31f724db95787139f608356bd834c1d83621a9c80870a5c959249e5f8540236ad5c2c686
|
data/README.md
CHANGED
@@ -1,11 +1,45 @@
|
|
1
1
|
# RailsVue3Quasar
|
2
2
|
|
3
|
-
|
3
|
+
The rails_vue3_quasar gem is a powerful and straightforward tool designed to integrate Vue 3 with Quasar as the frontend library into your Ruby on Rails application. This gem simplifies the process of setting up Vue 3 and Quasar, allowing you to focus on building amazing features without worrying about the initial setup.
|
4
4
|
|
5
|
-
|
5
|
+
Key Features:
|
6
|
+
Seamless Vue 3 Integration: Automatically configures your Rails app to work with Vue 3, enabling modern, reactive frontend development.
|
7
|
+
Quasar Framework Support: Brings the full power of Quasar's rich UI components and tools to your Rails app.
|
8
|
+
Effortless Setup: After installation, simply start your Rails server and enjoy a fully functional Vue 3 + Quasar environment.
|
9
|
+
How It Works:
|
10
|
+
Install the gem.
|
11
|
+
Run the provided setup commands.
|
12
|
+
Start the Rails server and begin building your application with a modern frontend stack.
|
13
|
+
This gem is perfect for developers looking for a hassle-free way to integrate a Vue 3 + Quasar frontend into their Ruby on Rails projects. Get started today and experience the seamless development process!
|
14
|
+
|
15
|
+
### **Libraries Included with `rails_vue3_quasar`**
|
16
|
+
|
17
|
+
The `rails_vue3_quasar` gem leverages several powerful libraries to enhance your development experience and streamline the integration of Vue 3 with Rails. Here’s an overview of the key dependencies included:
|
18
|
+
|
19
|
+
1. **`vite_rails` (`~> 3.0`, `>= 3.0.17`)**
|
20
|
+
- A modern asset bundler for Rails that integrates seamlessly with Vite.
|
21
|
+
- Handles efficient frontend bundling and live reloading during development for a smooth developer experience.
|
22
|
+
|
23
|
+
2. **`inertia_rails` (`~> 3.4`)**
|
24
|
+
- Bridges the gap between your Rails backend and Vue 3 frontend by enabling the use of Inertia.js.
|
25
|
+
- Allows you to build single-page applications without the complexity of a separate API.
|
26
|
+
|
27
|
+
3. **`js_from_routes` (`~> 4.0`, `>= 4.0.1`)**
|
28
|
+
- Provides a convenient way to generate JavaScript route helpers directly from your Rails routes.
|
29
|
+
- Makes it easier to reference your backend routes directly in Vue components.
|
30
|
+
|
31
|
+
These libraries work together to provide a robust and modern development stack, combining the power of Rails, Vue 3, and Quasar for building dynamic and responsive applications.
|
32
|
+
|
33
|
+
Ready to dive in? Install `rails_vue3_quasar` and enjoy an optimized development workflow!
|
6
34
|
|
7
35
|
## Installation
|
8
36
|
|
37
|
+
The rails_vue3_quasar gem is designed to work seamlessly with modern Ruby on Rails applications. Please ensure your environment meets the following requirements:
|
38
|
+
|
39
|
+
Rails Version: Compatible with Rails 6.0 or higher.
|
40
|
+
Ruby Version: Requires Ruby 2.5 or higher.
|
41
|
+
If your project does not meet these version requirements, consider upgrading your Rails or Ruby environment to enjoy the full benefits of rails_vue3_quasar.
|
42
|
+
|
9
43
|
Add this line to your application's Gemfile:
|
10
44
|
|
11
45
|
```ruby
|
@@ -22,7 +56,50 @@ Or install it yourself as:
|
|
22
56
|
|
23
57
|
## Usage
|
24
58
|
|
25
|
-
|
59
|
+
---
|
60
|
+
|
61
|
+
### **How to Use `rails_vue3_quasar`**
|
62
|
+
|
63
|
+
Follow these simple steps to get started with `rails_vue3_quasar` in your Ruby on Rails project:
|
64
|
+
|
65
|
+
1. **Install the Gem and Run the Setup Command**
|
66
|
+
After adding the gem to your Gemfile, navigate to your project directory and run the following command:
|
67
|
+
```bash
|
68
|
+
rails_vue3_quasar
|
69
|
+
```
|
70
|
+
Wait for the installation process to complete.
|
71
|
+
**Note:** If you encounter any errors related to missing dependencies, make sure to run `bundle install` first.
|
72
|
+
|
73
|
+
2. **Start the Rails Server**
|
74
|
+
Launch your Rails server using one of the following commands:
|
75
|
+
```bash
|
76
|
+
rails s
|
77
|
+
```
|
78
|
+
or
|
79
|
+
```bash
|
80
|
+
bin/dev
|
81
|
+
```
|
82
|
+
|
83
|
+
3. **Start the Vue Development Server**
|
84
|
+
In a separate terminal, start the Vue development server:
|
85
|
+
```bash
|
86
|
+
yarn dev
|
87
|
+
```
|
88
|
+
|
89
|
+
4. **Access the Demo Page**
|
90
|
+
Open your browser and navigate to the path:
|
91
|
+
```
|
92
|
+
http://localhost:3000/demo_vue
|
93
|
+
```
|
94
|
+
This is a demo page to verify that everything is set up correctly.
|
95
|
+
|
96
|
+
5. **Customize as You Wish**
|
97
|
+
Explore the project structure, review the Vue 3 and Quasar setup, and make any changes to suit your needs.
|
98
|
+
|
99
|
+
Good luck, and enjoy building with Rails, Vue 3, and Quasar!
|
100
|
+
|
101
|
+
---
|
102
|
+
|
26
103
|
|
27
104
|
## Development
|
28
105
|
|
data/rails_vue3_quasar.gemspec
CHANGED
@@ -30,13 +30,13 @@ Gem::Specification.new do |spec|
|
|
30
30
|
|
31
31
|
# Specify which files should be added to the gem when it is released.
|
32
32
|
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
33
|
-
spec.files = Dir.
|
34
|
-
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
35
|
-
end
|
33
|
+
spec.files = Dir.glob("lib/**/*") + Dir.glob("bin/*") + ["rails_vue3_quasar.gemspec", "README.md", "LICENSE.txt"]
|
36
34
|
spec.bindir = 'bin'
|
37
35
|
spec.executables = ['rails_vue3_quasar']
|
38
36
|
spec.require_paths = ['lib']
|
39
37
|
|
40
38
|
spec.add_development_dependency "bundler", "~> 1.17"
|
39
|
+
spec.add_development_dependency 'rails', '~> 6.0'
|
41
40
|
spec.add_development_dependency "rake", "~> 10.0"
|
41
|
+
spec.add_development_dependency 'ruby', '~> 2.3'
|
42
42
|
end
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rails_vue3_quasar
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- devhoanglv92
|
@@ -24,6 +24,20 @@ dependencies:
|
|
24
24
|
- - "~>"
|
25
25
|
- !ruby/object:Gem::Version
|
26
26
|
version: '1.17'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rails
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '6.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '6.0'
|
27
41
|
- !ruby/object:Gem::Dependency
|
28
42
|
name: rake
|
29
43
|
requirement: !ruby/object:Gem::Requirement
|
@@ -38,6 +52,20 @@ dependencies:
|
|
38
52
|
- - "~>"
|
39
53
|
- !ruby/object:Gem::Version
|
40
54
|
version: '10.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: ruby
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '2.3'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '2.3'
|
41
69
|
description: Auto add vue3 and quasar to rails project
|
42
70
|
email:
|
43
71
|
- devhoanglv92@gmail.com
|
@@ -46,12 +74,8 @@ executables:
|
|
46
74
|
extensions: []
|
47
75
|
extra_rdoc_files: []
|
48
76
|
files:
|
49
|
-
- ".gitignore"
|
50
|
-
- CODE_OF_CONDUCT.md
|
51
|
-
- Gemfile
|
52
77
|
- LICENSE.txt
|
53
78
|
- README.md
|
54
|
-
- Rakefile
|
55
79
|
- bin/console
|
56
80
|
- bin/rails_vue3_quasar
|
57
81
|
- bin/setup
|
data/.gitignore
DELETED
data/CODE_OF_CONDUCT.md
DELETED
@@ -1,74 +0,0 @@
|
|
1
|
-
# Contributor Covenant Code of Conduct
|
2
|
-
|
3
|
-
## Our Pledge
|
4
|
-
|
5
|
-
In the interest of fostering an open and welcoming environment, we as
|
6
|
-
contributors and maintainers pledge to making participation in our project and
|
7
|
-
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
-
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
-
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
-
orientation.
|
11
|
-
|
12
|
-
## Our Standards
|
13
|
-
|
14
|
-
Examples of behavior that contributes to creating a positive environment
|
15
|
-
include:
|
16
|
-
|
17
|
-
* Using welcoming and inclusive language
|
18
|
-
* Being respectful of differing viewpoints and experiences
|
19
|
-
* Gracefully accepting constructive criticism
|
20
|
-
* Focusing on what is best for the community
|
21
|
-
* Showing empathy towards other community members
|
22
|
-
|
23
|
-
Examples of unacceptable behavior by participants include:
|
24
|
-
|
25
|
-
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
-
advances
|
27
|
-
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
-
* Public or private harassment
|
29
|
-
* Publishing others' private information, such as a physical or electronic
|
30
|
-
address, without explicit permission
|
31
|
-
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
-
professional setting
|
33
|
-
|
34
|
-
## Our Responsibilities
|
35
|
-
|
36
|
-
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
-
behavior and are expected to take appropriate and fair corrective action in
|
38
|
-
response to any instances of unacceptable behavior.
|
39
|
-
|
40
|
-
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
-
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
-
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
-
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
-
threatening, offensive, or harmful.
|
45
|
-
|
46
|
-
## Scope
|
47
|
-
|
48
|
-
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
-
when an individual is representing the project or its community. Examples of
|
50
|
-
representing a project or community include using an official project e-mail
|
51
|
-
address, posting via an official social media account, or acting as an appointed
|
52
|
-
representative at an online or offline event. Representation of a project may be
|
53
|
-
further defined and clarified by project maintainers.
|
54
|
-
|
55
|
-
## Enforcement
|
56
|
-
|
57
|
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
-
reported by contacting the project team at TODO: Write your email address. All
|
59
|
-
complaints will be reviewed and investigated and will result in a response that
|
60
|
-
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
-
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
-
Further details of specific enforcement policies may be posted separately.
|
63
|
-
|
64
|
-
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
-
faith may face temporary or permanent repercussions as determined by other
|
66
|
-
members of the project's leadership.
|
67
|
-
|
68
|
-
## Attribution
|
69
|
-
|
70
|
-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
-
available at [http://contributor-covenant.org/version/1/4][version]
|
72
|
-
|
73
|
-
[homepage]: http://contributor-covenant.org
|
74
|
-
[version]: http://contributor-covenant.org/version/1/4/
|
data/Gemfile
DELETED
data/Rakefile
DELETED