PHPackages                             hdeawy/api-starter-kit - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. hdeawy/api-starter-kit

ActiveProject[Framework](/categories/framework)

hdeawy/api-starter-kit
======================

Comprehensive boilerplate designed specifically for backend developers who need to quickly scaffold RESTful APIs.

v1.3.3(1y ago)302085MITPHPPHP ^8.2

Since Apr 22Pushed 1y ago1 watchersCompare

[ Source](https://github.com/hdeawy/api-starter-kit)[ Packagist](https://packagist.org/packages/hdeawy/api-starter-kit)[ RSS](/packages/hdeawy-api-starter-kit/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (15)Versions (9)Used By (0)

[![API Starter Kit](https://camo.githubusercontent.com/4eadd6507031e36c1f2c6c3e13978781cb82ff3bfb9c8e2f069658bc24a72634/68747470733a2f2f6864656177792d7075626c69632d73746f726167652e73332e75732d656173742d312e616d617a6f6e6177732e636f6d2f737461727465722d696e7374616c6c65722e6a7067)](https://github.com/hdeawy/api-starter-kit)

[![Total Downloads](https://camo.githubusercontent.com/7c93f213261a34e8236ca7ef5458c94611d455ca21ba34e4d8328c0de38f5904/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6864656177792f6170692d737461727465722d6b6974)](https://packagist.org/packages/hdeawy/api-starter-kit)[![Latest Stable Version](https://camo.githubusercontent.com/6db7a011ff8e8e85c30a3b172f82f2a6f4250eb757b628f3f4c33119f0cd3738/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6864656177792f6170692d737461727465722d6b6974)](https://packagist.org/packages/hdeawy/api-starter-kit)[![License](https://camo.githubusercontent.com/18987f1bbdfe8daaeacd38afe938d5147fdec696e0ddf03d284802f334986df4/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6864656177792f6170692d737461727465722d6b6974)](https://packagist.org/packages/hdeawy/api-starter-kit)[![](https://camo.githubusercontent.com/618c9e51e15e56c97355155237c39fbf4177cc83ad93b5d65cf4a2bbea9d82a0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f496e7374616c6c25323077697468253230486572642d6635353234373f6c6f676f3d6c61726176656c266c6f676f436f6c6f723d7768697465)](https://herd.laravel.com/new?starter-kit=hdeawy/api-starter-kit)

Laravel API Starter Kit
=======================

[](#laravel-api-starter-kit)

Idea Brief
----------

[](#idea-brief)

The Laravel API Starter Kit is a comprehensive boilerplate designed specifically for backend developers who need to quickly scaffold RESTful APIs using Laravel. Unlike general-purpose starter kits, this one focuses exclusively on API development, implementing industry best practices like Service and Repository patterns to ensure clean, maintainable, and testable code. This starter kit aims to solve common challenges in API development by providing a standardized structure, consistent response formats, and allowing developers to focus on business logic rather than repetitive boilerplate code.

Core Features
-------------

[](#core-features)

The API Starter Kit includes the following core features:

- Service Class Pattern
- Repository Pattern
- Standardized API Response Structure
- API Versioning
- Query Builder (Dynamic filtering, sorting, and pagination using Spatie Query Builder)
- Authentication using JWT
- Request Validation
- Resource Transformers
- API Documentation
- Telescope for Development &amp; Debugging.
- Code Quality Tools (Pint, Larastan, IDE Helper)
- Pest for Testing (already configured and ready to use, see current tests).
- Docker Configuration
- Git Hooks (pre-commit and pre-push to automatically run Pint, Larastan, and test suites)

### Requirements

[](#requirements)

- PHP 8.2+
- Composer
- MySQL 8.0+ / PostgreSQL 12+ / SQLite 3

### Installation

[](#installation)

#### Using Laravel Installer

[](#using-laravel-installer)

```
laravel new my-app --using=hdeawy/api-starter-kit
```

#### Using Composer

[](#using-composer)

```
composer create-project hdeawy/api-starter-kit
```

#### Using Docker

[](#using-docker)

- Install starter using Docker

```
docker run -it --rm \
    -v $(pwd):/app \
    -w /app \
    -e COMPOSER_ALLOW_SUPERUSER=1 \
    composer:2.5 \
    create-project hdeawy/api-starter-kit .
```

- Update the `.env` file with your database credentials

```
DB_CONNECTION=mysql
DB_HOST=mysql
DB_PORT=3306
DB_DATABASE=laravel_api
DB_USERNAME=root
DB_PASSWORD=password
```

- 🔥 Start the Docker containers

```
sail up -d
```

- Finally, run the migrations and generate the JWT secret

```
sail artisan migrate
```

```
sail artisan jwt:secret
```

#### Manually

[](#manually)

- Clone the repository

```
git clone git@github.com:hdeawy/api-starter-kit.git
cd api-starter-kit
```

- Install dependencies

```
composer install
```

- Copy the `.env.example` file to `.env` and set your environment variables

```
cp .env.example .env
```

- Final setup

```
php artisan key:generate
php artisan jwt:secret
php artisan migrate
```

### Testing

[](#testing)

Run the tests with Pest:

```
php artisan test
```

[![API Starter Kit](https://camo.githubusercontent.com/5e3d7e132621ab79e53ff8c4fd8bde2ebe5b0dcf958174857b4d66c66f9f5666/68747470733a2f2f6864656177792d7075626c69632d73746f726167652e73332e75732d656173742d312e616d617a6f6e6177732e636f6d2f74657374732e706e67)](https://github.com/hdeawy/api-starter-kit)

### Laravel Pint

[](#laravel-pint)

Code style fixer for minimalists

```
composer pint
```

[![API Starter Kit](https://camo.githubusercontent.com/b1d5fedb3938e57448494a756699de4c507cd21c7815d7c76a72e20d84f49612/68747470733a2f2f6864656177792d7075626c69632d73746f726167652e73332e75732d656173742d312e616d617a6f6e6177732e636f6d2f70696e742e706e67)](https://github.com/hdeawy/api-starter-kit)

### Larastan

[](#larastan)

Finding errors in your code:

```
composer stan
```

[![API Starter Kit](https://camo.githubusercontent.com/fbfbc03e016fabeb9ee86c162e0ba148c885d4c0a73223b8dfbfca269b5513f1/68747470733a2f2f6864656177792d7075626c69632d73746f726167652e73332e75732d656173742d312e616d617a6f6e6177732e636f6d2f7374616e2e706e67)](https://github.com/hdeawy/api-starter-kit)

### Contributing

[](#contributing)

Thank you for considering contributing to this API Starter Kit!. All the contribution guidelines are mentioned [here](CONTRIBUTING.md).

### Security Vulnerabilities

[](#security-vulnerabilities)

If you discover a security vulnerability within the starter kit, please send an e-mail to me via .

### License

[](#license)

This Laravel API Starter Kit is open-sourced software licensed under the [MIT license](LICENSE.md).

###  Health Score

37

—

LowBetter than 83% of packages

Maintenance48

Moderate activity, may be stable

Popularity24

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

7

Last Release

384d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/cdc1ed69169b09d0f23145994ebf196ce4a851df0000e29363d000f86959b756?d=identicon)[AhmedHdeawy](/maintainers/AhmedHdeawy)

---

Top Contributors

[![AhmedHdeawy](https://avatars.githubusercontent.com/u/15928500?v=4)](https://github.com/AhmedHdeawy "AhmedHdeawy (36 commits)")

---

Tags

apiframeworklaravelrest

###  Code Quality

TestsPest

Static AnalysisPHPStan

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/hdeawy-api-starter-kit/health.svg)

```
[![Health](https://phpackages.com/badges/hdeawy-api-starter-kit/health.svg)](https://phpackages.com/packages/hdeawy-api-starter-kit)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
