Helg18 / laravel-api

Laravel API starter Kit will provide you with the tools for making API's that everyone will love

Laravel API Starter Kit

Laravel API starter Kit will provide you with the tools for making API's that everyone will love, API Authentication is already provided with passport. We brought the power of the Tactician Command bus to laravel in a simple package https://github.com/joselfonseca/laravel-tactician created and maintained by Jose Fonseca.

Here is a list of the packages installed:

• Laravel Tactician Command Bus
• Laravel API Tools
• Laravel Passport
• Laravel Permission
• Laravel Uuid

Installation

To install the project you can use composer

composer create-project joselfonseca/laravel-api new-api

You may receive an error about the key files after the installation, that is OK. To fix it run the following in the project's root

touch storage/oauth-private.key
touch storage/oauth-public.key

Then run composer install again and the error should be gone.

Modify the .env file to suit your needs

APP_ENV=local
APP_DEBUG=true
APP_KEY=base64:JqyMTmt5qr1CW6BH+GG+4iKfU4RiNjZTLy33TdTT7+4=

DB_HOST=localhost
DB_DATABASE=laravel_api
DB_USERNAME=homestead
DB_PASSWORD=secret

CACHE_DRIVER=file
SESSION_DRIVER=file
QUEUE_DRIVER=sync

MAIL_DRIVER=smtp
MAIL_HOST=mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null

When you have the .env with your database connection set up you can run your migrations

php artisan migrate

Then run php artisan passport:install

Run php artisan app:install and fill out the information of the admin user.

Run yarn install to install node dependencies

Run npm run dev to compile the CSS and JS

You should be done with the basic configuration.

Tests

Navigate to the project root and run vendor/bin/phpunit after installing all the composer dependencies and after the .env file was created.

License

The Laravel API Starter kit is open-sourced software licensed under the MIT license