laravelflux/laravel-api-template

Laravel API Project Template

1.0.0 2018-02-21 23:10 UTC

README

36246510?s=200&v=4

Laravel API Template


A RESTful application boilerplate in Laravel taking best practices and utilizing best available packages and tools

It includes all commonly used configurations that would allow you to focus on adding new features to your application.

Latest Stable Version Total Downloads License Build Status Scrutinizer Code Quality

FEATURES

  • RESTful endpoints in the widely accepted format
  • JWT-based authentication
  • Data validation
  • Full test coverage
  • Sign in, Sign up, Forgot Password, Update User Profile
  • Support Docker

REQUIREMENTS

The minimum requirements for this project:

  • PHP 7.1
  • PostgreSQL 9.6
  • Redis

Installing using Docker

You need to have docker (1.17.0+) and docker-compose (1.14.0+) installed.

You can install the application using the following commands:

composer create-project --no-install --stability=dev laravelflux/laravel-api-template api
cd api
cp .env.example .env && cp docker-compose.override.yml{.dist,}
docker-compose up -d --build

In .env file your need to set your UID. You can get your UID by the following command in the terminal: id -u <username>

It may take some minutes to download the required docker images. When done, you need to install vendors as follows:

docker-compose exec web bash
composer install
chown -R www-data:www-data .

When done, you need to execute the following commands in the web container:

  • php artisan key:generate
  • php artisan migrate

After this steps, you can access your app from http://localhost:8099/api/docs.