Template project for PHP libraries.
- dev-main / 1.x-dev
This package is auto-updated.
Last update: 2023-04-19 20:37:45 UTC
A starter PHP project with many services and features pre-configured.
The things this project provides or does includes:
For more details, see the section Explanation of Features, below.
To get started, export your GitHub personal access token and then create a new project.
$ export GITHUB_TOKEN='...'
$ composer create-project g1a/starter my-new-project
The new project will be owned by the currently-authenticated user. If you would like to create a new project in an organization instead, then set the
GITHUB_ORG environment variable.
$ export GITHUB_ORG='my-github-username-or-org'
The new project will work only with php 8.0 and later. If you need to use an earlier version of php (as far back as php 7.1), then instead run:
$ composer create-project g1a/starter my-new-project:^2
Once the new project is created, automated scripts will customize it and set up a number of serivces. See the section Description of Features below for more information. Once the scripts have finished running, you may customize your README file and start coding!
Generating and exporting a personal access token for the services below is recommended, as doing this will allow the post-create-project scripts to configure and enable these services automatically.
|Token Generation URL
|Generate GitHub token
If the personal access token for these services is not set up, then the service may be manually configured later. In addition, this project is also configured for use with Packagist, this service only needs to be manually authorized through their web interface to enable them for projects created with this template.
Follow the links in the table below to configure the services you would like to use.
|Manual Setup URL
|Create GitHub project
|Register with Packagist
composer create-project command runs to create your new project from the templates provided, a GitHub project will automatically be created, and your code will automatically be pushed up.
In order for this to work, you must define a
GITHUB_TOKEN environment variable as described in the usage section.
Your new project will be set up with the outline for a project README, complete with status badges, ready to be customized. Follow the instructions provided in your new project to complete the customization steps.
GitHub actions will automatically run your unit tests every time a commit is pushed up to GitHub.
Packagist is the main repository for Composer projects. The customization instructions for your project includes a link you may follow to register your project in this repository.
Your new project comes with a trivial
Example class with tests that demonstrate the phpunit @dataProvider feature.
The included test suite demonstrates testing on multiple platforms and PHP versions.
In addition to providing unit tests with phpunit, your new project will also automatically contain style checks for PSR-2 coding convnetions, and will lint your code for syntax errors and other problems.
These features may be accessed via
composer cs and
composer lint commands, respectively. A .editorconfig file is provided pre-configured to maintain PSR-2 coventions in editors that support this feature.
GitHub has a feature that allows projects to define pull request and issue templates which will be presented to users when a new issue or pull request is opened. Also, a contributing document can be provided to explain project conventions to new users.
Starter versions for all of these files are automatically added to your new project, and may be customized as needed. By default, the CONTRIBUTING.md file is added to the project root for better visiblity, but you may move it to the .github directory if you prefer.
Your project will be set up to build a commandline tool, and also includes commands to package it as a phar using the humbug/box project. If your project is a library, you might still wish to include a commandline tool to provide ad-hoc usage to your library functions, either for testing purposes, or perhaps to directly edit any data stores managed by your library. The commandline tool dependencies are declared in the
require-dev section, so they will not be pulled in when your project is included as the dependency of some other project.
If you do not want the commandline tool, simply delete the directories
tests/ExampleCommandsTest.php, and also remove the
phar:* commands in your composer.json file, and the files
composer.json file included in the project pre-configures a few settings for convenience:
optimize-autoloader: Creates larger autoload files that find classes more quickly
sort-packages: Keeps the list of packages in alphabetic order
platform:php: Ensures that Composer will only select packages that are compatible with the stated minimum PHP version.
Your project's .gitattributes file comes pre-configured to exclude unnecessary files in Composer
Your project will automatically read in a configuration file in yaml format that you may use for providing command option default values and storing other user-overridable settings. See consolidation/config for more information.
Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.
This project is licensed under the MIT License - see the LICENSE file for details.