Download the PHP package mrprotocoll/api-boilerplate-laravel without Composer
On this page you can find all versions of the php package mrprotocoll/api-boilerplate-laravel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mrprotocoll/api-boilerplate-laravel
More information about mrprotocoll/api-boilerplate-laravel
Files in mrprotocoll/api-boilerplate-laravel
Package api-boilerplate-laravel
Short Description This Laravel 11 API boilerplate provides a structured foundation for building robust backend applications with Laravel, integrating essential features and tools.
License MIT
Informations about the package api-boilerplate-laravel
๐น๏ธ๐น๏ธ Laravel API Boilerplate๐น๏ธ๐น๏ธ
๐ Table of Contents
- ๐ About the Project
- ๐ Built With
- Tech Stack
- ๐ Links
- Features
- ๐ Built With
- ๐ป Getting Started
- Setup
- Prerequisites
- Usage
- ๐ค Contributing
๐ API Boilerplate
A robust, modular Laravel 11 API boilerplate built using a Domain-Driven Design (DDD) approach. This boilerplate provides a scalable foundation for modern API development with essential features like role-based access, versioning, Google OAuth integration, and more..
Features
- Domain-Driven Architecture: Organized modules and shared resources for scalability.
- Versioning: Supports multiple API versions with structured routing.
- Role-Based Access Control: Integrated roles and permissions with easy extensibility.
- Google OAuth: Simplified OAuth 2.0 authentication setup.
- Modular Components: Independent modules for Auth, User, and more.
- Enums and Helpers: Centralized, reusable enums and helper methods.
- Custom Middlewares: Pre-configured middlewares for JSON responses, caching, logging, and preventing duplicate requests.
- Optimized Exception Handling: Friendly and consistent error responses.
- Custom Base Model: A UUID-enabled base model for consistency across entities.
- Seeders and Factories: Simplified data seeding with predefined roles.
- Rate Limiting: API throttling to prevent abuse.
- Fully Documented: Swagger/OpenAPI support for API documentation.
Architecture Overview
Domain-Driven Design (DDD)
The project structure is organized to separate concerns:
src/modules
: Contains feature-specific modules, e.g., Auth and User.
src/shared
: Shared resources like helpers, enums, and base classes.
Versioning
Version-specific modules and routes are located in the V1
directory for flexibility.
Tech Stack
(back to top)
๐ Links
To access the documentation goto the below link
-
Link to api routes
- Link to documentation
(back to top)
๐ป Getting Started
To get a local copy up and running, follow these steps.
Prerequisites
In order to run this boilerplate, you need:
-
PHP ^8.2
use the following link to setupPHP
if you dont have it already installed on your computer - Composer
use the following link to DownloadComposer
if you dont have it already installed on your computer
Install
clone the repository:
Install dependencies:
Setup
Create your database.
create .env file, change using the .env.example file and update the Database, Google Oauth (optional), and Email credentials.
Generate keys, Run the migration and seed roles:
Usage
The following command can be used to run the application.
(back to top)
Contributing
Feel free to fork the repository, make changes, and submit pull requests. Feedback is always welcome!
License
This project is licensed under the MIT License.
All versions of api-boilerplate-laravel with dependencies
ext-fileinfo Version *
darkaonline/l5-swagger Version ^8.6
laravel/breeze Version ^2.1
laravel/framework Version ^11.9
laravel/sanctum Version ^4.0
laravel/socialite Version ^5.15
laravel/tinker Version ^2.9
larowka/prevent-duplicate-requests Version ^1.1