README

API Starter Kit

A Laravel API starter kit with a focus on building robust and scalable API services. This starter kit comes pre-configured with essential tools and best practices for API development.

Features

PHP 8.3+ and Laravel 12.0+
Docker setup with PHP 8.3, FPM, and Nginx
API documentation with Scramble
Authentication with Laravel Sanctum
Testing setup with Pest
Code quality tools (Pint, PHPStan)

Prerequisites

PHP 8.3 or higher
Composer
Docker and Docker Compose (optional, for containerized development)
MySQL or SQLite for database

Installation

You can install this starter kit using one of the following methods:

1. Using Composer Create-Project

composer create-project pikarin/ajt-api-starter your-project-name
cd your-project-name

2. Using Laravel New Command

First, make sure you have the Laravel installer:

composer global require laravel/installer

Then create a new project using this starter kit:

laravel new --using pikarin/ajt-api-starter your-project-name
cd your-project-name

3. Using Laravel Herd

If you're using Laravel Herd, you can click the "Install with Herd" badge:

Post-Installation Steps

After installing the project, you should:

Configure your environment variables:
```
cp .env.example .env
```
Install dependencies:
```
composer install
```
Generate key:
```
php artisan key:generate
```

Set up your database in the .env file:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=your_database_name
DB_USERNAME=your_database_user
DB_PASSWORD=your_database_password

Run migrations:
```
php artisan migrate
```
Start the development server:
```
docker-compose up -d
```

Running Tests

php artisan test

pikarin / ajt-api-starter

Maintainers

Details