codelytv/php-bootstrap

Starting point if you want to bootstrap a project in PHP following best practices.

🐘 PHP Bootstrap (base / project skeleton)

![Software License][ico-license] , _(*1)

Introduction

This is a repository intended to serve as a starting point if you want to bootstrap a project in PHP. This repository has been explained in the CodelyTV video "Introducción a PHP: Cómo configurar tu entorno de desarrollo 🐘" (Spanish)., _(*2)

It could be useful if you want to start from scratch a kata or a little exercise or project. The idea is that you don't have to worry about the boilerplate, just run composer create-project codelytv/php-bootstrap your-project-name and there you go:, _(*3)

• Latest versions of PHP and PHPUnit
• Best practices applied:
  • README.md
  • LICENSE
  • composer.json
  • ecs.php
  • phpunit.xml
  • psalm.xml
  • .gitignore
  • .editorconfig
• Some useful resources to start coding

How To Start

You have 2 different alternatives: Using our Packagist project with Composer, or manually cloning this repo:, _(*4)

Using Composer

Start completely from scratch without having to delete this bootstrap project Git history:, _(*5)

1. If you don't have it already, install Composer.
2. Create your project based on the Packagist project. This will also download the project dependencies: composer create-project codelytv/php-bootstrap your-project-name.
3. Move to the project directory: cd your-project-name
4. Run all the checks: composer test. This will do some checks that you can perform with isolated commands:
   1. Codely Style: composer lint.
   2. Easy coding standard: composer style. If you want to fix style issues automatically: composer lint:fix.
   3. Static Analysis: composer static-analysis.
   4. PHP Unit: composer phpunit.
5. Create your own repository:
   1. Initialize your own Git repository: git init
   2. Add the bootstrap files: git add .
   3. Commit: git commit -m "Initial commit with project boilerplate based on https://github.com/CodelyTV/php-bootstrap"
   4. Add your remote repository: git remote add origin git@github.com:your-username/your-project-name
   5. Upload your local commits to the new remote repo: git push -u origin master
6. Start coding!

Cloning the repository

Just in case you prefer to avoid dealing with composer create-project, you can also clone this repository. We recommend to follow the next step-by-step process in order to avoid adding the bootstrap project commits to your project Git history:, _(*6)

1. Use this repository template
2. Clone your project
3. Move to the project directory: cd your-project-name
4. If you don't have it already, install Composer.
5. Install the project dependencies: composer install
6. Run the tests: composer test.
7. Start coding!

Related skeleton templates

This very same basic skeleton philosophy implemented in other programming languages:, _(*7)

• 🔷🕸️ TypeScript Web Skeleton
• 🔷🌍 TypeScript API Skeleton
• 🔷✨ TypeScript DDD Skeleton
• ✨ JavaScript Basic Skeleton
• ☕ Java Basic Skeleton
• 📍 Kotlin Basic Skeleton
• 🧬 Scala Basic Skeleton
• 🦈 C# Basic Skeleton