preparing v1.x

Author: aagjalpankaj

.docker/application/entrypoint.d/99-extras.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+echo "⏰ Scheduling tasks!"
+php /var/www/html/artisan schedule:work &

.docker/application/php/xdebug-ci.ini

@@ -0,0 +1,11 @@
+[xdebug]
+xdebug.force_display_errors=1
+xdebug.cli_color=0
+xdebug.scream=0
+xdebug.show_exception_trace=1
+xdebug.mode=coverage
+xdebug.discover_client_host=false
+xdebug.client_host=
+xdebug.idekey=
+xdebug.start_with_request=no
+xdebug.log_level=0

.docker/application/php/xdebug-dev.ini

@@ -0,0 +1,11 @@
+[xdebug]
+xdebug.force_display_errors=1
+xdebug.cli_color=1
+xdebug.scream=0
+xdebug.show_exception_trace=1
+xdebug.mode=debug,develop
+xdebug.discover_client_host=true
+xdebug.client_host=host.docker.internal
+xdebug.idekey=larabase
+xdebug.start_with_request=trigger
+xdebug.log_level=0

.docker/database/.gitkeep

@@ -0,0 +1,15 @@
+*
+!/app
+!/artisan
+!/bootstrap
+!/config
+!/database
+!/public
+!/resources
+!/routes
+!/storage
+!composer.*
+!/vendor
+!/.env
+!/*.js
+!/.docker

.dockerignore

@@ -0,0 +1,51 @@
+# Installation
+
+
+## Pre-requisites
+[Docker](https://docs.docker.com/engine/install/) (_recommended_) or [php 8.4](https://www.php.net/releases/8.4/en.php) installed locally.
+
+> **ℹ️** How do I quickly install php8.4 on my local? Install [Herd](https://herd.laravel.com). It's easy!
+
+> **⚠️** If you're not planning to use Docker, please make sure to configure [xdebug](https://herd.laravel.com/docs/macos/debugging/xdebug) for code coverage.
+
+## Create project
+
+### Github
+Click on the "use this template" button. Clone the created repository on your local.
+
+### GitLab or other
+Download source code from the [release](https://github.com/laralaunch/the-boilerplate/releases/).
+
+## Spin-up
+
+### Docker (Recommended)
+
+Run (First time, it will take a couple of minutes as it will build `dev` image from `Dockerfile`):
+```
+docker compose up -d
+```
+
+Inside the application container, run below commands one by one:
+```
+composer install
+cp .env.example .env
+php artisan key:generate
+touch database/database.sqlite
+php artisan migrate
+```
+
+Done! Visit http://localhost:8765
+
+### Locally
+
+> Make sure php 8.4 is installed and Xdebug is configured
+
+Run below commands one by one:
+```
+composer install
+cp .env.example .env
+php artisan key:generate
+touch database/database.sqlite
+php artisan migrate
+php artisan serve
+```

.docs/100-INSTALLATION.md

@@ -0,0 +1,7 @@
+# Development
+
+- Always stick to the [defaults](https://laravel.com/docs/11.x) whenever possible. 
+- Do not try to [over-engineer](https://www.codesimplicity.com/post/what-is-overengineering).
+- Refer below best practices or similar resources.
+  - [benjamincrozat/best-practices](https://benjamincrozat.com/laravel-best-practices)
+  - [alexeymezenin/laravel-best-practices](https://github.com/alexeymezenin/laravel-best-practices?tab=readme-ov-file#contents)

.docs/200-DEVELOPMENT.md

@@ -0,0 +1,53 @@
+# Reviewing changes locally
+
+Run all CI checks locally (lint, static analysis, rector, tests - architecture, unit & feature tests)
+```
+composer ci
+```
+
+Fix possible CI checks locally (Fixes rector & linting issues automatically)
+```
+composer ci.fix
+```
+
+---
+
+Check linting issues:
+```
+composer lint
+```
+
+Fix linting issues:
+```
+composer lint.fix
+```
+
+Check rector issues:
+```
+composer rector
+```
+
+Fix rector issues:
+```
+composer rector.fix
+```
+
+Check static analysis:
+```
+composer stan
+```
+
+Run architecture tests:
+```
+composer test.arch
+```
+
+Run unit tests:
+```
+composer test.unit
+```
+
+Run feature tests:
+```
+composer test.feature
+```

.docs/300-TESTING.md

@@ -0,0 +1,27 @@
+# CI/CD
+
+## Continuous Integration (CI)
+
+This boilerplate includes a built-in [GitHub CI workflow](../docs/../.github/workflows/100-ci.yml) with essential checks. Feel free to modify it as your application grows.
+
+### Included Checks:
+- `composer lint`: Ensures consistent code style across your project.
+- `composer rector`: Keeps your codebase up to date with the latest best practices.
+- `composer test.arch`: Performs architecture validation.
+- `composer test.unit`: Runs unit tests.
+- `composer test.feature`: Executes feature tests, ensuring at least 90% test coverage.
+
+## Continuous Deployment (CD)
+
+### Containerized Deployment:
+If you wish to use containerized deployment, a pre-configured [Dockerfile](./../Dockerfile) is provided, utilizing the [serversideup/docker-php](https://serversideup.net/open-source/docker-php/) image.
+
+By default, the deploy job pushes the image to an AWS ECR repository. If you're using an AWS compute service that supports container images (e.g., AppRunner, Lambda, or EKS), deployment should work out of the box once you configure the following GitHub secrets and variables:
+
+- `AWS_ACCESS_KEY_ID` _(secret)_
+- `AWS_SECRET_ACCESS_KEY` _(secret)_
+- `AWS_ECR_REGISTRY` _(secret)_
+- `AWS_ECR_REPOSITORY` _(variable)_
+- `AWS_REGION` _(variable)_
+
+If you prefer a non-AWS containerized deployment, simply modify the `.github/workflows/200-cd.yml` file as needed.