suin / skeleton
PHP project.
1.0.0
2018-01-03 11:37 UTC
Requires
- php: >=7.1
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.9
- phpunit/phpunit: ^6.5
- suin/livexample: ^1.2
This package is auto-updated.
Last update: 2024-11-06 09:09:46 UTC
README
This is where your library description should go. Try to limit it to a paragraph or two.
Features
- ...
- ...
- ...
Installation
$ composer require suin/skeleton
Examples
// Some example code here
See more examples, visit ./example folder.
Changelog
Please see CHANGELOG for more details.
Contributing
Please see CONTRIBUTING for more details.
Followings should be deleted when you publish your library.
Skeleton
A template repository for kicking start PHP library development.
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 openSubmitting this package to Packagist
- Enter repository URL.
- Set up GitHub Integrations & services.
- Check if the package is distributed:
composer show -a suin/skeleton
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>