b-deshayes / laravel-api-starter

⚗ A simple Laravel based API that can be use such as a starter kit

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PHP Unit PHP Insights GitHub

📣 About this respository

This repository is a prepared template which can be used to create an API. It contains all the necessary a pre-configured packages needed to concentrate yourself on the essential of the API.

📌 Current features

  • Auto generated documentation with Scribe
  • Development docker-compose
  • JWT token system
  • GitHub Action PHPInsights and PHPUnit workflows
  • Repository pattern
  • Artisan command to generate repository (artisan make:repository ModelName)
  • Dynamic settings system

🗺 Roadmap

  • ACL system based on permissions and roles
  • Artisan command to generate an API endpoint model based on entity
  • Production docker compose stack

📦 Packages used

🐳 How to use docker-compose local stack

docker-compose up -d --build # Build and up the stack
docker-compose run --rm composer update # Execute a composer
docker-compose run --rm npm run dev # Execute an npm command
docker-compose run --rm artisan migrate # Execute artisan command
docker-compose run --rm artisan apidoc:generate # Generate the API documentation
docker-compose run --rm artisan make:repository User # Generate the user repository

📎 Sources

📄 License

The Laravel framework is open-sourced software licensed under the MIT license.

About

⚗ A simple Laravel based API that can be use such as a starter kit


Languages

Language:PHP 73.7%Language:HTML 24.7%Language:Blade 1.2%Language:Shell 0.3%Language:Dockerfile 0.0%