https://github.com/jeroendedauw/new-php-library

Template for quickly starting PHP libraries
https://github.com/jeroendedauw/new-php-library

template

Last synced: 8 days ago
JSON representation

Template for quickly starting PHP libraries

• Host: GitHub
• URL: https://github.com/jeroendedauw/new-php-library
• Owner: JeroenDeDauw
• License: bsd-3-clause
• Created: 2019-01-17T09:10:14.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-16T23:07:37.000Z (almost 2 years ago)
• Last Synced: 2024-10-16T14:41:14.089Z (about 1 month ago)
• Topics: template
• Language: PHP
• Size: 21.5 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# PHP Library Template

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/JeroenDeDauw/new-php-library/ci.yml?branch=master)](https://github.com/JeroenDeDauw/new-php-library/actions?query=workflow%3ACI)

[![Type Coverage](https://shepherd.dev/github/JeroenDeDauw/new-php-library/coverage.svg)](https://shepherd.dev/github/JeroenDeDauw/new-php-library)

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

## Usage

TODO

## 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

Start by installing the project dependencies by executing

    composer update

You can run the tests by executing

    make test

    

You can run the style checks by executing

    make cs

    

To run all CI checks, execute

    make ci

    

You can also invoke PHPUnit directly to pass it arguments, as follows

    vendor/bin/phpunit --filter SomeClassNameOrFilter