https://github.com/cable8mm/phpunit-start-kit

PHPUNIT Start Kit is the simple code for starting TDD
https://github.com/cable8mm/phpunit-start-kit

boilerplate composer composer-package php8 phpunit psr-12 psr-4 skeleton template

Last synced: about 2 months ago
JSON representation

PHPUNIT Start Kit is the simple code for starting TDD

• Host: GitHub
• URL: https://github.com/cable8mm/phpunit-start-kit
• Owner: cable8mm
• License: mit
• Created: 2019-07-24T14:46:38.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-09T12:58:21.000Z (10 months ago)
• Last Synced: 2024-07-30T20:05:33.391Z (5 months ago)
• Topics: boilerplate, composer, composer-package, php8, phpunit, psr-12, psr-4, skeleton, template
• Language: PHP
• Homepage:
• Size: 57.6 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# PHPUNIT Start Kit

[![code-style](https://github.com/cable8mm/phpunit-start-kit/actions/workflows/code-style.yml/badge.svg)](https://github.com/cable8mm/phpunit-start-kit/actions/workflows/code-style.yml)

[![run-tests](https://github.com/cable8mm/phpunit-start-kit/actions/workflows/run-tests.yml/badge.svg)](https://github.com/cable8mm/phpunit-start-kit/actions/workflows/run-tests.yml)

![Packagist Version](https://img.shields.io/packagist/v/cable8mm/phpunit-start-kit)

![Packagist Downloads](https://img.shields.io/packagist/dt/cable8mm/phpunit-start-kit)

![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/cable8mm/phpunit-start-kit/php)

![Packagist Stars](https://img.shields.io/packagist/stars/cable8mm/phpunit-start-kit)

![Packagist License](https://img.shields.io/packagist/l/cable8mm/phpunit-start-kit)

This serves as a template for creating a new library.

## Features

- [x] Built-in PHPUnit and lint libraries

- [x] Pre-configured GitHub Actions

- [x] Pre-configured `composer.json` and `phpunit.xml` files as part of the skeleton

- [x] Built-in CHANGELOG.md file and automatic commit action

- [x] Built-in MIT License document

## Install

```sh

composer require cable8mm/phpunit-start-kit

```

## Usage

```sh

composer create-project cable8mm/phpunit-start-kit 

```

You can customize `src/StartKit.php` and `tests/StartKitTest.php`, and modify `composer.json` to tailor it to your package name and author information.

## Formatting

```sh

composer lint

```

## Test

```sh

composer test

```

## License

The Phpunit Start Kit is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).