|
| 1 | +# Laravel Vue Starter |
| 2 | + |
| 3 | +The project was created to save myself time for redoing the same things all over again when starting a new Laravel/Vue project. |
| 4 | + |
| 5 | +The main goal of this project is to reduce code and make everything simpler for bootstrapping new projects. |
| 6 | + |
| 7 | +The project is built with the following components: |
| 8 | + |
| 9 | +- Vue 3 / Vuex / VueRouter |
| 10 | +- Vue 3 Composition API |
| 11 | +- Laravel Framework |
| 12 | +- Laravel Sanctum |
| 13 | +- Laravel Fortify |
| 14 | +- Tailwind |
| 15 | + |
| 16 | +## How to install |
| 17 | + |
| 18 | +Installation is simple. Just like your ordinary Laravel app. |
| 19 | + |
| 20 | +1. `git clone` |
| 21 | +2. `cd laravel-vue-starter` |
| 22 | +3. `composer install` |
| 23 | +4. `cp .env.example .env` |
| 24 | +5. `php artisan key:generate` |
| 25 | +6. `npm install` |
| 26 | +7. `npm run dev` |
| 27 | + |
| 28 | +## How it works |
| 29 | + |
| 30 | +### Authentication |
| 31 | + |
| 32 | +The project ships with complete authentication boilerplate and includes the following pages: |
| 33 | +- Login |
| 34 | +- Register |
| 35 | +- Forget Password |
| 36 | +- Reset Password |
| 37 | + |
| 38 | +### Structure |
| 39 | + |
| 40 | +All the front-end code is located in `resources/js`. The code is well organized in different directories to make things more readable. |
| 41 | + |
| 42 | +- `components` - This is the reusable components home |
| 43 | +- `pages` - Here you will add the pages |
| 44 | +- `plugins` - The plugins configurations |
| 45 | +- `router` - The router configuration including the middleware and the routes |
| 46 | +- `services` - The API services reside here |
| 47 | +- `store` - The store configuration |
| 48 | +- `utils` - Misc reusable functions and utils |
| 49 | + |
| 50 | +### Examples |
| 51 | + |
| 52 | +The project ships with the `Messages` component that is just an example of the CRUD operations in a Laravel and Vue project. |
| 53 | + |
| 54 | +You will probably remove the examples once you start developing your app on top of this project. |
| 55 | + |
| 56 | +## Contributions |
| 57 | + |
| 58 | +Pull requests are welcome, feel free to contribute to this project. |
| 59 | + |
| 60 | +## LICENSE |
| 61 | + |
| 62 | +``` |
| 63 | +Copyright (C) 2021 Darko Gjorgjijoski (https://darkog.com) |
| 64 | +
|
| 65 | +This file is part of Laravel Vue Starter |
| 66 | +
|
| 67 | +Laravel Vue Starter is free software: you can redistribute it and/or modify |
| 68 | +it under the terms of the GNU General Public License as published by |
| 69 | +the Free Software Foundation, either version 2 of the License, or |
| 70 | +(at your option) any later version. |
| 71 | +
|
| 72 | +Laravel Vue Starter is distributed in the hope that it will be useful, |
| 73 | +but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 74 | +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 75 | +GNU General Public License for more details. |
| 76 | +
|
| 77 | +You should have received a copy of the GNU General Public License |
| 78 | +along with Laravel Vue Starter. If not, see <https://www.gnu.org/licenses/>. |
| 79 | +``` |
0 commit comments