A modern, production-ready REST API boilerplate built with Laravel 12. This repository is designed to kickstart robust backend development with best practices, automated documentation, and secure authentication out of the box.
- Standardized RESTful Architecture: Clean and scalable structure for modern API development.
- JWT Authentication: Secure user authentication using
tymon/jwt-auth. - Auto-generated Documentation: Real-time API documentation via Scramble (no manual PHPDoc required).
- Modern Testing Suite: Pre-configured with Pest PHP for elegant and efficient testing.
- Developer Friendly: Includes pre-defined scripts for setup, testing, and development.
- Docker Ready: Includes
Dockerfileand.dockerignorefor containerized environments.
- Framework: Laravel 12.x
- Language: PHP 8.2+
- Security: JSON Web Token (JWT)
- Documentation: Scramble (OpenAPI/Swagger)
- Testing: Pest PHP
- Utilities: Laravel Tinker, Pint (Style Fixer), Sail (Docker)
-
Clone the repository
git clone https://github.com/arsyadkamaluddin/laravel-rest-api-boiler-plate.git cd laravel-rest-api-boiler-plate -
Automated Setup Run the pre-defined setup script to install dependencies, generate keys, and run migrations:
composer run setup
-
Environment Setup Ensure your
.envfile has the correct database credentials. -
Run Development Server
php artisan serve
Once the server is running, you can access the automatically generated API documentation at:
http://localhost:8000/docs/api
Kamaluddin Arsyad Fadllillah Fullstack Web Developer | UGM Software Engineering