Laravel-Vue-Spa-Boilerplate

Getting started

Introduction

• This is a Laravel (5.5) Vue js SPA(Single page application) Boilerplate Project with JWT Authentication.

Installation

Please check the official laravel installation guide for server requirements before you start. Official Documentation

Clone the repository

git clone https://github.com/viitoradmin/laravel-vue-spa-boilerplate.git

Switch to the repo folder

cd laravel-vue-spa-boilerplate

Install all the dependencies using composer

composer install

Copy the example env file and make the required configuration changes in the .env file

cp .env.example .env

Generate a new application key

php artisan key:generate

Generate a new JWT authentication secret key

php artisan jwt:generate

If you have linux system, you can execute below command only in your project root

1) sudo chmod -R 777 install.sh
2) ./install.sh

Run Artisan Command for database setup, connection and configuration.

php artisan install:app

Please add proper information while performing above command.

or you can setup manually using below command

Run the database migrations (Set the database connection in .env before migrating)

php artisan migrate

Start the local development server

php artisan serve

You can now access the server at http://localhost:8000

For Windows system command list

git clone https://github.com/viitoradmin/laravel-vue-spa-boilerplate.git
cd laravel-vue-spa-boilerplate
composer install
cp .env.example .env
php artisan key:generate
php artisan jwt:secret

Make sure you set the correct database connection information before running the migrations Environment variables

php artisan migrate
php artisan serve

Demo Credentials

Email:- [email protected]

Password:- 123456

Environment variables

• .env - Environment variables can be set in this file

Note : You can quickly set the database information and other variables in this file and have the application fully working.

Repository Creation

• If you want to create "Base Repository" and BaseRepository.php not exist in your project at that time, you can execute below command. php artisan make:repository BaseRepository -b
• If you want to create repository for any module, you can execute below command php artisan make:repository
• If you want to create repository inside "Asset" folder, php artisan make:repository Asset\
• If you want to create repository directly inside "Repository" folder, php artisan make:repository

Authentication

This applications uses JSON Web Token (JWT) to handle authentication. The token is passed with each request using the Authorization header with Token scheme. The JWT authentication middleware handles the validation and authentication of the token. Please check the following sources to learn more about JWT.

• https://jwt.io/introduction/
• https://self-issued.info/docs/draft-ietf-oauth-json-web-token.html

Issues

If you come across any issues please report them here.

Contributing

Feel free to create any pull requests for the project. For proposing any new changes or features you want to add to the project, you can send us an email at [email protected] or [email protected]

License

MIT LICENSE