Skip to content
/ laravel-php-8 Public template

Boilerplate Laravel PHP8, using SQL, JWT, Swagger, Docker, Migrations.

Notifications You must be signed in to change notification settings

gbrayhan/laravel-php-8

Repository files navigation

Boilerplate Laravel 8 and PHP 8

This repo is functionality complete — PRs and issues welcome!


Getting started

Installation

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

Alternative installation is possible without local dependencies relying on Docker.

Clone the repository

git clone git@github.com:gbrayhan/laravel-php-8.git

Switch to the repo folder

cd laravel-php-8

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:secret

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

TL;DR command list

git clone git@github.com:gbrayhan/laravel-php-8.git
cd laravel-php-8
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

Docker

To install with Docker, run following commands:

git clone git@github.com:gbrayhan/laravel-php-8.git
cd laravel-php-8
cp .env.example .env
docker-compose up -d
docker exec php_app php artisan key:generate
docker exec php_app php artisan jwt:secret
docker exec php_app php artisan migrate

The api can be accessed at http://localhost:8000/api.

API Specification

This application adheres to the api specifications set by the Thinkster team. This helps mix and match any backend with any other frontend without conflicts.

Full API Spec

More information regarding the project can be found here https://github.com/gothinkster/realworld


Code overview

Dependencies

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.


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.


Releases

No releases published

Packages

No packages published

Languages