README

🕹️🕹️ Laravel API Boilerplate🕹️🕹️

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
  • 🚀 Links
  • Features
• 💻 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

• PHP
• Laravel

(back to top)

🚀 Links

To access the documentation goto the below link

• Link to api routes

http://localhost:8000/v1

• Link to documentation

http://localhost:8000/v1/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:

1. PHP ^8.2
   use the following link to setup PHP if you dont have it already installed on your computer

(install PHP)

1. Composer
   use the following link to Download Composer if you dont have it already installed on your computer

(install Composer)

Install

clone the repository:

git clone git@github.com:mrprotocoll/api-boilerplate-laravel.git

Install dependencies:

composer install

Setup

Create your database.

create .env file, change using the .env.example file and update the Database, Google Oauth (optional), and Email credentials.

cp .env.example .env

Generate keys, Run the migration and seed roles:

php artisan key:generate 
php artisan migrate --seed

Usage

The following command can be used to run the application.

  php artisan serve

(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.