Download the PHP package tfarla/composer-template without Composer
On this page you can find all versions of the php package tfarla/composer-template. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tfarla/composer-template
More information about tfarla/composer-template
Files in tfarla/composer-template
Package composer-template
Short Description A template for creating composer libraries
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package composer-template
Composer template
Making development of composer libraries easy with this cloneable template which includes:
- continuous integration (travis ci)
- code coverage (coveralls)
- static analysis (phpstan)
- mess detector (phpmd)
- testing framework (phpunit)
- php code sniffer which enforces the psr-2 standard (phpcs)
- composer configuration with psr-4 autoloading
- a changelog
- MIT license (not sure about what license you need? https://choosealicense.com/)
- documentation using sphinx
- issue and pull request template
- badges from http://shields.io/
Requirements
- php 7.1 or greater (supported versions)
- python & pip to create documentation
- composer
Installation
The following command will clone this template and place it in the my-library directory
Composer's create-project will also install all dependencies in this template:
Once the download is done you will get the choice to remove the .git directory which you should do if you want your own repository.
Usage
In order to use this template you'll need to change a few things:
- Change the content in this README file to reflect your library
- Change the content in the
docs/directory to reflect your library - Setup travis-ci (should be plug & play)
- Setup readthedocs (should be plug & play)
- Setup coveralls (should be plug & play)
- Pick a license https://choosealicense.com/ (MIT is good enough for most open source project, but you might want to look at the other options)
Documentation
While this README should be enough to get started. Please read the full documentation for more details.
Contributing
Thanks for reading this far into the README and considering contributing to this project. If you have any questions or suggestions feel free to create an issue.
If you want to modify the code then please follow these steps:
- Fork it (https://github.com/TFarla/composer-template)
- Create your feature branch (git checkout -b feature/fooBar)
- Commit your changes (git commit -am 'Add some fooBar')
- Push to the branch (git push origin feature/fooBar)
- Create a new Pull Request
