/php-basic-skeleton

๐Ÿ˜๐Ÿš€ PHP Basic Skeleton: Bootstrap your new projects using this Composer Project

Primary LanguagePHPMIT LicenseMIT

PHP Bootstrap (base / project skeleton)

Latest Version on Packagist Software License Build Status Quality Score Total Downloads

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).

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:

How To Start

You have 2 different alternatives: Using our Packagist project with Composer, or manually cloning this repo:

Using Composer

Start completely from scratch without having to delete this bootstrap project Git history:

  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. PHP Parallel Lint: composer lint.
    2. PHP Style Check: composer style. If you want to fix style issues automatically: composer fix-style.
    3. 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:

  1. Use this repositoy 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 all the checks: composer test. This will do some checks that you can perform with isolated commands:
    1. PHP Style Check: composer style. If you want to fix style issues automatically: composer fix-style.
    2. PHP Unit: composer phpunit.
  7. Start coding!

Helpful resources

PHP 7

PHPUnit

Refactoring

Other programming languages

About

This hopefully helpful utility has been developed by CodelyTV and [contributors][link-contributors].

We'll try to maintain this project as simple as possible, but Pull Requests are welcomed!

License

The MIT License (MIT). Please see License File for more information.