-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.md
196 lines (153 loc) · 8.53 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<br>
<div align="center">
<img src="https://gitlab.com/shuashuaa/v-kit-app/-/raw/main/@shuashuaa-v-kit.png?ref_type=heads" width="300" />
</div>
<div align="center">
<h1>create-v-kit-spa</h1>
</div>
<div align="center">
<p>
A simple way to start your vue-laravel-spa projects.
<!-- A collection of vue-laravel-spa boilerplates Powered by vue, laravel, <br>
vite/webpack, vuetify and pinia. up-to-date, ready for local-deployment and fully customizable. -->
<!-- Looking for a boilerplate for your next project? Kickstart it with v-kit-spa now! -->
</p>
</div>
<div align="center">
<p>
<!-- https://shields.io/badges/npm-package-minimized-gzipped-size-scoped -->
<!-- https://simpleicons.org/ -->
<!-- <a href="https://www.npmjs.com/package/create-v-kit-spa"><img src="https://img.shields.io/npm/v/create-v-kit-spa?color=c95f8b&label=" alt="NPM version"></a>
<a href="https://www.npmjs.com/package/create-v-kit-spa"><img src="https://img.shields.io/npm/dw/create-v-kit-spa?style=flat-square" alt="NPM downloads"></a>
<a href="https://github.com/shuashuaa/v-kit/blob/main/LICENSE"><img src="https://img.shields.io/npm/v/create-v-kit-spa?style=flat-square" alt="License"></a> -->
<a href="https://github.com/shuashuaa/v-kit/blob/main/LICENSE"><img src="https://img.shields.io/npm/v/create-v-kit-spa?style=flat-square&logo=npm&color=ffe963" alt="VERSION"></a>
<a href="https://www.npmjs.com/package/create-v-kit-spa"><img src="https://img.shields.io/npm/dw/create-v-kit-spa?style=flat-square&logo=npm&color=ffe963" alt="NPM DOWNLOADS"></a>
<a href="https://github.com/shuashuaa/v-kit/blob/main/LICENSE"><img src="https://img.shields.io/bundlejs/size/create-v-kit-spa?style=flat-square&logo=npm&color=ffe963" alt="MINIFIED SIZE"></a>
<!-- 007EC6 -->
</p>
</div>
<!-- [](https://www.npmjs.com/package/vkit)
[](https://www.npmjs.com/package/vkit)
[](https://github.com/shuashuaa/v-kit/blob/main/LICENSE) -->
<br>
## Create your project
```sh
npm create v-kit-spa@latest
```
<br>
## Prerequisite
- `Apache/Nginx`
- `Mysql`
- `Php`
- `Node`
<!-- > Php to Laravel Version Table
| Php Version | Laravel Version |
| :-------------- | :------------------|
| `7.4` | `^8.0x` |
| `8.0` | `^9.0x` |
| `8.1` | `^10.0x` |
| `8.2` | `^11.0x` | -->
<!-- Download PHP Versions
https://windows.php.net/downloads/releases/archives/php-8.0.9-Win32-vs16-x64.zip -->
<br>
# Reference Table (❗ PHP Version is Important ❗)
### Mono Repo
> frontend and backend are in a single folder, united via configuration.
| Version & Type | Features | Prerequisite |
| :--------------------| :-------------------------------------------------------| :-------------------------------|
| `vue 2 - laravel 8` | runs in `webpack`, Development Ready | php `v7.4` && node `v18^` |
| `vue 3 - laravel 8` | runs in `webpack`, Development Ready | php `v7.4` && node `v18^` |
| `vue 3 - laravel 9` | runs in `vite`, Development Ready, Developer Friendly | php `v8.0` && node `v18^` |
| `vue 3 - laravel 10` | runs in `vite`, Development Ready, Developer Friendly | php `v8.1` && node `v18^` |
| `vue 3 - laravel 11` | runs in `vite`, Development Ready, Developer Friendly | php `v8.2 - v8.3` && node `v18^`|
```
/
└── Project folder/
├── *Laravel and Vue files are combined here*
└── README.md
```
<!-- ### Decoupled Repo
> frontend and backend are separated, much easier to update/upgrade either if needed.
| Version & Type | Structure | Features | Prerequisite |
| :------------------------ | :------------| :---------------------------------------------------------------------| :-----------------|
| `vue 3 - laravel 8` | `Decoupled` | runs in `vite` w/ the following: `pinia`, `vuetify 3`, `vue-router`, `developer friendly` |php `v7.4` && node `^18x` |
```
/
├── FrontEnd/
│ └── Vuejs files
└── Backend/
└── Laravel files
``` -->
<br>
# Installation
<!-- [](#) -->
## Vue 2 - Laravel 8
> bundled and optimized in `webpack` 🕸️
| Commands | Action |
| :-------------------------- | :--------------------------------------------|
| `yarn install` | Installs node dependencies |
| `composer install` | Installs composer dependencies |
| `copy .env.example .env` | Generates a .env file from an example |
| `php artisan key:generate` | Generates a key for .env file |
| `npm run artisan-watch` | Run both `php artisan serve` and `yarn watch`|
| `http://127.0.0.1:8000/` | Visit your app, Enjoy! 🎉🎉 |
<br>
## Vue 3 - Laravel 8
> bundled and optimized in `webpack` 🕸️
| Commands | Action |
| :------------------------ | :--------------------------------------------|
| `yarn install` | Installs node dependencies |
| `composer install` | Installs composer dependencies |
| `copy .env.example .env` | Generates a .env file from an example |
| `php artisan key:generate`| Generates a key for .env file |
| `npm run artisan-watch` | Run both `php artisan serve` and `yarn watch`|
| `http://127.0.0.1:8081/` | Visit your app, Enjoy! 🎉🎉 |
<br>
## Vue 3 - Laravel 9
> bundled and optimized in `vite` ⚡
| Commands | Action |
| :------------------------ | :--------------------------------------------|
| `yarn install` | Installs node dependencies |
| `composer install` | Installs composer dependencies |
| `copy .env.example .env` | Generates a .env file from an example |
| `php artisan key:generate`| Generates a key for .env file |
| `npm run artisan-dev` | Run both `php artisan serve` and `yarn dev` |
| `http://127.0.0.1:8000/` | Visit your app, Enjoy! 🎉🎉 |
<br>
## Vue 3 - Laravel 10
> bundled and optimized in `vite` ⚡
| Commands | Action |
| :------------------------ | :--------------------------------------------|
| `yarn install` | Installs node dependencies |
| `composer install` | Installs composer dependencies |
| `copy .env.example .env` | Generates a .env file from an example |
| `php artisan key:generate`| Generates a key for .env file |
| `npm run artisan-dev` | Run both `php artisan serve` and `yarn dev` |
| `http://127.0.0.1:8000/` | Visit your app, Enjoy! 🎉🎉 |
<br>
## Vue 3 - Laravel 11
> bundled and optimized in `vite` ⚡
| Commands | Action |
| :------------------------ | :--------------------------------------------|
| `yarn install` | Installs node dependencies |
| `composer install` | Installs composer dependencies |
| `copy .env.example .env` | Generates a .env file from an example |
| `php artisan key:generate`| Generates a key for .env file |
| `php artisan migrate` | Create a Sessions table |
| `npm run artisan-dev` | Run both `php artisan serve` and `yarn dev` |
| `http://127.0.0.1:8000/` | Visit your app, Enjoy! 🎉🎉 |
| `npm run build ` | Deploy! 🎉🎉 |
<br>
## Docs
Read full docs [here](https://github.com/Shuashuaa/v-kit-spa#readme).
## How to contribute
Have an idea? Found a bug? See [how to contribute](https://github.com/Shuashuaa/v-kit-spa/wiki/Contributing).
## Contributors
Thanks to:
- [RGienz](https://github.com/RGienz) for contributing and maintaining [vuejs3 - laravel8](#vue-3---laravel-8) 👏
<!-- <br>
## Changelog
To learn about the specific changes in each release, check the [Changelog](./Changelog).
<br> -->
## License
Free and Open Source Under [MIT](./LICENSE) License © 2024-PRESENT [Shuashuaa](https://github.com/Shuashuaa)