A Composer ready starter kit
source link: http://keepcoding.ehsanabbasi.com/php/composer-ready-starter-kit/
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
A Composer ready starter kit
After doing a few open-source projects I found myself doing some steps again and again to setup a new repository on GitHub. I live in PHP world and what I normally do is to create a Composer package along with CI operations and bunch of automated code review tools.
This might seem like an overkill specially for small projects but believe or not it pays off as the project grows. So I came up with a Composer ready starter kit to help speed up starting PHP projects on GitHub which can be found here. It includes:
composer.json
to publish your package on https://packagist.org and also to manage dependencies- Travis CI configuration file
- Scrutinizer CI configuration file
- Code Climate configuration file
- PHPUnit configuration file
- PHP Mess Detector configuration file
- MIT License
- Directory structure for source code and tests
- Readme badges
- StyleCI
- Codacy
To get started:
- Pull the repo
- Rename any
php-base-project
andPhpBaseProject
with your project name and appropriate namespace - Create an account on Travis, Scrutinizer and Code Climate and allow access to your repository
- Update
composer.json
with the relevant information to your project - Update .travis.yml with your repository token from Code Climate
- Update readme file with the right path to the badges
- Update author name in the license
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK