https://github.com/jeroendedauw/gol-baby-steps

https://github.com/jeroendedauw/gol-baby-steps

Last synced: 8 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/jeroendedauw/gol-baby-steps
• Owner: JeroenDeDauw
• License: other
• Created: 2017-10-04T10:38:04.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-06T13:41:41.000Z (about 7 years ago)
• Last Synced: 2024-10-16T14:41:14.862Z (about 1 month ago)
• Language: PHP
• Size: 21.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: COPYING.txt

Awesome Lists containing this project

README

        
# PHP Project Template

[![Build Status](https://travis-ci.org/JeroenDeDauw/new-php-project.svg?branch=master)](https://travis-ci.org/JeroenDeDauw/new-php-project)

This is a template for starting new PHP projects. Copy or fork to get started quickly.

(Update this section)

## Contents

* Ready-to-go PHPUnit (configuration and working bootstrap)

* Ready-to-go PHPCS

* Docker environment with PHP 7.1 and Composer (so you do not need to have PHP or Composer installed!)

* Tests and style checks runnable in the Docker environment with simple `make` commands 

* TravisCI ready

* Code coverage creation on TravisCI and uploading to ScrutinizerCI (optional)

* Coverage tag validation

* Stub production and test classes for ultra-quick start (ideal when doing a kata)

* COPYING and .gitignore files

* README with instructions of how to run the tests

(Delete this section)

## Getting started

* Copy the code or fork the repository

* If you do not want to use the MediaWiki coding style, remove `mediawiki/mediawiki-codesniffer` from `composer.json`

* If you want to support older PHP versions, update `composer.json` and remove new PHP features from the stub PHP files

* If the code is not a kata or quick experiment, update the PHP namespaces and the README

* Start writing code!

* If you want TravisCI and/or ScrutinizerCI integration you will need to log in to their respective websites 

(Delete this section)

## Installation

To use the UPDATE_NAME library in your project, simply add a dependency on UPDATE/NAME

to your project's `composer.json` file. Here is a minimal example of a `composer.json`

file that just defines a dependency on UPDATE_NAME 1.x:

```json

{

    "require": {

        "UPDATE/NAME": "~1.0"

    }

}

```

## Development

For development you need to have Docker and Docker-compose installed. Local PHP and Composer are not needed.

    sudo apt-get install docker docker-compose

### Running Composer

To pull in the project dependencies via Composer, run:

    make composer install

You can run other Composer commands via `make run`, but at present this does not support argument flags.

If you need to execute such a command, you can do so in this format:

    docker run --rm --interactive --tty --volume $PWD:/app -w /app\

     --volume ~/.composer:/composer --user $(id -u):$(id -g) composer composer install -vvv

### Running the CI checks

To run all CI checks, which includes PHPUnit tests, PHPCS style checks and coverage tag validation, run:

    make

    

### Running the tests

To run just the PHPUnit tests run

    make test

To run only a subset of PHPUnit tests or otherwise pass flags to PHPUnit, run

    docker-compose run --rm app ./vendor/bin/phpunit --filter SomeClassNameOrFilter