Update README.md

README.md

@@ -1,64 +1,64 @@
-<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400"></a></p>
+# Laravel Inertia Vite Template
 
-<p align="center">
-<a href="https://travis-ci.org/laravel/framework"><img src="https://travis-ci.org/laravel/framework.svg" alt="Build Status"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
-</p>
+**Simple yet powerful template for Laravel Vue applications.**
 
-## About Laravel
+Create your awesome project with awesome template, featuring lots of features and ready to use such as :
 
-Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
+ - Full single page application with simplified UI, routing and navigation.
+ - Permission will help you organize user, role more flexible with builtin settings.
+ - Builtin draggable menu to set your menu easily.
+ - Builtin authentication with seeder.
+ - Supports multi-language web application.
+ - Dark and light themes 🌓
+---
+## Requirements
+ - PHP 8.1 or higher
+ - Node JS 14 or higher
 
-- [Simple, fast routing engine](https://laravel.com/docs/routing).
-- [Powerful dependency injection container](https://laravel.com/docs/container).
-- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
-- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
-- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
-- [Robust background job processing](https://laravel.com/docs/queues).
-- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
+---
+## Installation
 
-Laravel is accessible, powerful, and provides tools required for large, robust applications.
+  This might take awhile but I'm pretty sure this is worth it. So let's get started.
 
-## Learning Laravel
+  1. Clone the repository
 
-Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
+     ```git clone https://github.com/Geriano/laravel-inertia-vite-template.git```
 
-If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains over 2000 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
+  2. Install dependencies
 
-## Laravel Sponsors
+      ```
+      cd laravel-inertia-vite-template
+      composer install
+      npm install
+      ```
   
-We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel [Patreon page](https://patreon.com/taylorotwell).
+  3. Copy .env.example to .env
 
-### Premium Partners
+      ``` cp .env.example .env ```
   
-- **[Vehikl](https://vehikl.com/)**
-- **[Tighten Co.](https://tighten.co)**
-- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
-- **[64 Robots](https://64robots.com)**
-- **[Cubet Techno Labs](https://cubettech.com)**
-- **[Cyber-Duck](https://cyber-duck.co.uk)**
-- **[Many](https://www.many.co.uk)**
-- **[Webdock, Fast VPS Hosting](https://www.webdock.io/en)**
-- **[DevSquad](https://devsquad.com)**
-- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
-- **[OP.GG](https://op.gg)**
-- **[WebReinvent](https://webreinvent.com/?utm_source=laravel&utm_medium=github&utm_campaign=patreon-sponsors)**
-- **[Lendio](https://lendio.com)**
+  4. Generate key application
 
-## Contributing
+      ``` php artisan key:generate ```
   
-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
+  5. Configure your database in .env
+      ```
+      DB_CONNECTION=mysql (can be changed to other database)
+      DB_HOST=your_database_host
+      DB_PORT=your_database_port
+      DB_DATABASE=your_database_name
+      DB_USERNAME=your_database_user
+      DB_PASSWORD=your_database_password
+      ```
+  6. Run migrations and initial seeder
 
-## Code of Conduct
+      ``` php artisan migrate:fresh --seed ```
   
-In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
+  7. Run web server 
   
-## Security Vulnerabilities
+      ``` php artisan serve ```
 
-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
+  8. Run vite server 
   
-## License
+      ``` npm run dev ```
     
-The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+  9. Open your browser and go to [localhost](http://localhost:8000) and now you ready to build your apps!