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).
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:
- Latest versions of PHP and PHPUnit
- Best practices applied:
README.md(badges included)LICENSEcomposer.jsonphpunit.xml.gitignore.editorconfig.travis.yml.scrutinizer.yml
- Some useful resources to start coding
You have 2 different alternatives: Using our Packagist project with Composer, or manually cloning this repo:
Start completely from scratch without having to delete this bootstrap project Git history:
- If you don't have it already, install Composer.
- Create your project based on the Packagist project. This will also download the project dependencies:
composer create-project codelytv/php-bootstrap your-project-name. - Move to the project directory:
cd your-project-name - Run all the checks:
composer test. This will do some checks that you can perform with isolated commands:- PHP Parallel Lint:
composer lint. - PHP Style Check:
composer style. If you want to fix style issues automatically:composer fix-style. - PHP Unit:
composer phpunit.
- PHP Parallel Lint:
- Create your own repository:
- Initialize your own Git repository:
git init - Add the bootstrap files:
git add . - Commit:
git commit -m "Initial commit with project boilerplate based on https://github.com/CodelyTV/php-bootstrap" - Add your remote repository:
git remote add origin git@github.com:your-username/your-project-name - Upload your local commits to the new remote repo:
git push -u origin master
- Initialize your own Git repository:
- Start coding!
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:
- Clone this repository:
git clone https://github.com/CodelyTV/php-bootstrap your-project-name - Move to the project directory:
cd your-project-name - If you don't have it already, install Composer.
- Install the project dependencies:
composer install - Run all the checks:
composer test. This will do some checks that you can perform with isolated commands:- PHP Parallel Lint:
composer lint. - PHP Style Check:
composer style. If you want to fix style issues automatically:composer fix-style. - PHP Unit:
composer phpunit.
- PHP Parallel Lint:
- Create your own repository cleaning the bootstrap project history:
- Remove previous Git history in order to do not add the bootstrap repo noise in your project:
rm -rf .git - Initialize your own Git repository:
git init - Add the bootstrap files:
git add . - Commit:
git commit -m "Initial commit with project boilerplate based on https://github.com/CodelyTV/php-bootstrap" - Add your remote repository:
git remote add origin git@github.com:your-username/your-project-name - Upload your local commits to the new remote repo:
git push -u origin master
- Remove previous Git history in order to do not add the bootstrap repo noise in your project:
- Start coding!
- Refactoring.guru Code Smells catalog
- Refactoring.guru Refactorings catalog
- SourceMaking Refactorings catalog
- Martin Fowler Refactorings catalog
- CodelyTV Refactoring videos (Spanish)
This hopefully helpful utility has been developed by CodelyTV and contributors.
We'll try to maintain this project as simple as possible, but Pull Requests are welcomed!
The MIT License (MIT). Please see License File for more information.