Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ramsey/php-library-starter-kit
:building_construction: A tool to quickly set up the base files of a PHP library project.
https://github.com/ramsey/php-library-starter-kit
composer-commands library php skeleton
Last synced: 5 days ago
JSON representation
:building_construction: A tool to quickly set up the base files of a PHP library project.
- Host: GitHub
- URL: https://github.com/ramsey/php-library-starter-kit
- Owner: ramsey
- License: mit
- Created: 2019-01-03T04:32:46.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T03:55:46.000Z (25 days ago)
- Last Synced: 2024-12-14T07:01:49.017Z (12 days ago)
- Topics: composer-commands, library, php, skeleton
- Language: PHP
- Homepage:
- Size: 637 KB
- Stars: 245
- Watchers: 8
- Forks: 25
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
PHP Library Starter Kit
A starter kit for quickly setting up a new PHP library package.
## About
ramsey/php-library-starter-kit is a package that may be used to generate a basic
PHP library project directory structure, complete with many of the starting
files (i.e. README, LICENSE, GitHub issue templates, PHPUnit configuration,
etc.) that are commonly found in PHP libraries. You may use the project
directory that's created as a starting point for creating your own PHP libraries.
This project adheres to a [code of conduct](CODE_OF_CONDUCT.md).
By participating in this project and its community, you are expected to
uphold this code.
## Usage
``` bash
composer create-project ramsey/php-library-starter-kit YOUR-PROJECT-NAME
```
Running this command will create a new repository containing the same files
and structure as this repository. Afterward, it will run the
`Ramsey\Dev\LibraryStarterKit\Wizard::start()` method to set up the project, which will
walk you through a series of questions and make changes to files based on your
answers. When complete, it will remove the `./src/LibraryStarterKit` and `./tests/LibraryStarterKit`
directories, leaving everything else in place with an initial commit.
### Using An Existing Answers File
When executing `create-project`, if you exit the program while in the middle of
the question prompts, you might notice it creates a `.starter-kit-answers` file
in the project directory. When you return later and run `composer starter-kit`,
it will use this file to pre-fill any questions you've already answered. Once
finished, the starter kit removes this file.
You may also use an existing answers file to provide all your answers to the
prompts, including skipping the question prompts. To do this, set an environment
variable with the path to your answers file:
```shell
STARTER_KIT_ANSWERS_FILE=/path/to/starter-kit-answers.json
```
To skip the question prompts, make sure you include the `skipPrompts` property
in the answers file, and set it to `true`.
The answers file is a JSON object, consisting of all the public properties found
in `Ramsey\Dev\LibraryStarterKit\Answers`.
For example:
```json
{
"authorEmail": "[email protected]",
"authorHoldsCopyright": true,
"authorName": "Author Smith",
"authorUrl": "https://example.com/",
"codeOfConduct": "Contributor-2.0",
"codeOfConductCommittee": null,
"codeOfConductEmail": "[email protected]",
"codeOfConductPoliciesUrl": null,
"codeOfConductReportingUrl": null,
"copyrightEmail": "[email protected]",
"copyrightHolder": "Acme, Inc.",
"copyrightUrl": "https://example.com/acme",
"copyrightYear": "2021",
"githubUsername": "example",
"license": "MIT",
"packageDescription": "An awesome library that does stuff.",
"packageKeywords": [
"awesome",
"stuff"
],
"packageName": "acme/awesome",
"packageNamespace": "Acme\\Awesome",
"projectName": "My Awesome Library",
"securityPolicy": true,
"securityPolicyContactEmail": "[email protected]",
"securityPolicyContactFormUrl": null,
"skipPrompts": true,
"vendorName": "acme"
}
```
## Contributing
Contributions are welcome! To contribute, please familiarize yourself with
[CONTRIBUTING.md](CONTRIBUTING.md).
## Coordinated Disclosure
Keeping user information safe and secure is a top priority, and we welcome the
contribution of external security researchers. If you believe you've found a
security issue in software that is maintained in this repository, please read
[SECURITY.md](SECURITY.md) for instructions on submitting a vulnerability report.
## FAQs
### Why did you include package/tool *x* and not *y*?
I created this project starter kit for my own uses, and these are the
common files, packages, and tools I use in my PHP libraries. If you like what
you see, feel free to use it. If you like some of it but not all, fork it and
customize it to fit your needs. I hope you find it helpful!
## Copyright and License
ramsey/php-library-starter-kit is copyright © [Ben Ramsey](https://benramsey.com)
and licensed for use under the terms of the
MIT License (MIT). Please see [LICENSE](LICENSE) for more information.