suin/skeleton

PHP project.

Skeleton

![travis-ci-badge] ![packagist-dt-badge] ![license-badge] ![release-version-badge] ![code-climate-maintainability-badge] ![code-climate-test-coverage-badge] !php-version-badge, _(*1)

This is where your library description should go. Try to limit it to a paragraph or two., _(*2)

Features

1. ...
2. ...
3. ...

Installation

``` bash $ composer require suin/skeleton, <sub>(*3)</sub>

## Examples

```php
// Some example code here

See more examples, visit ./example folder., <sub>(*4)</sub>

Changelog

Please see CHANGELOG for more details., <sub>(*5)</sub>

Contributing

Please see CONTRIBUTING for more details., <sub>(*6)</sub>

Followings should be deleted when you publish your library., <sub>(*7)</sub>

Skeleton

A template repository for kicking start PHP library development., <sub>(*8)</sub>

Features

• Unit testing ready
  • PHPUnit
  • Livexample: Ensures your example codes works well by unit testing.
  • Cross PHP version testing powered by Docker containers
    • From PHP 5.3 to PHP 7.2 or later
• Code quality tools bundled
  • PHP-CS-Fixer
  • Built-in PHP-CS-Fixer rules powered by suin/php-cs-fixer-rules
  • Code coverage
• Ready for collaboration
  • CONTRIBUTING
  • PHP-CS-Fixer
  • Well-configured Git
    • .gitattributes
    • .gitignore
    • .gitmessage
  • Travis CI integration
  • Code coverage reports powered by Code Climate
  • Automated code review powered by Code Climate
• Reusable documents
  • README.md
    • Badges powered by shields.io
  • CHANGELOG.md
    • You may generate it by github-changelog-generator.

How to use this

git clone git@github.com:suin/php-skeleton.git ./your-lib-name
cd ./your-lib-name
rm -rf .git
git init
git commit --allow-empty -m "Initial commit."

Setting up Travis CI

: Install travis client
  gem install travis
  
  : Authenticate your travis account
  travis login
  
  : Triggers a new sync with GitHub
  travis sync
  
  : Enable CI
  travis enable
  
  : Visit CI dashboard
  travis open
  

Submitting this package to Packagist

1. Visit https://packagist.org/packages/submit

* Enter repository URL. * Set up GitHub Integrations & services. * Check if the package is distributed: composer show -a suin/skeleton, <sub>(*9)</sub>

Codeclimate code coverage setting

• Add repository to Codeclimate.
• Get test reporter ID from "Settings" → "Test coverage" → "TEST REPORTER ID".
• Set Travis CI environment.

travis env set CC_TEST_REPORTER_ID <your reporter id>