{"id":20980645,"url":"https://github.com/php-api-clients/installer","last_synced_at":"2025-07-28T20:09:47.871Z","repository":{"id":52422294,"uuid":"79730854","full_name":"php-api-clients/installer","owner":"php-api-clients","description":" :floppy_disk: YAML based project installer","archived":false,"fork":false,"pushed_at":"2023-12-15T05:49:03.000Z","size":170,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-29T15:41:04.508Z","etag":null,"topics":["hacktoberfest","installer","php","php7","reactphp","yaml"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/php-api-clients.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-01-22T16:52:01.000Z","updated_at":"2023-09-19T01:48:18.000Z","dependencies_parsed_at":"2023-12-15T06:51:22.260Z","dependency_job_id":null,"html_url":"https://github.com/php-api-clients/installer","commit_stats":{"total_commits":93,"total_committers":4,"mean_commits":23.25,"dds":"0.31182795698924726","last_synced_commit":"07adeed5c1daf3e4c5947aebc7ef2173a30d1bd1"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/php-api-clients/installer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/php-api-clients%2Finstaller","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/php-api-clients%2Finstaller/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/php-api-clients%2Finstaller/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/php-api-clients%2Finstaller/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/php-api-clients","download_url":"https://codeload.github.com/php-api-clients/installer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/php-api-clients%2Finstaller/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267578003,"owners_count":24110351,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-28T02:00:09.689Z","response_time":68,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","installer","php","php7","reactphp","yaml"],"created_at":"2024-11-19T05:29:28.481Z","updated_at":"2025-07-28T20:09:47.853Z","avatar_url":"https://github.com/php-api-clients.png","language":"PHP","readme":"# Configurable package installer\n\nYAML based project installer inspired by [`IceHawk installer`](https://github.com/icehawk/installer) and [`Koriym.PhpSkeleton`](https://github.com/koriym/Koriym.PhpSkeleton)\n\n[![Build Status](https://travis-ci.org/php-api-clients/installer.svg?branch=master)](https://travis-ci.org/php-api-clients/installer)\n[![Latest Stable Version](https://poser.pugx.org/api-clients/installer/v/stable.png)](https://packagist.org/packages/api-clients/installer)\n[![Total Downloads](https://poser.pugx.org/api-clients/installer/downloads.png)](https://packagist.org/packages/api-clients/installer)\n[![Code Coverage](https://scrutinizer-ci.com/g/php-api-clients/installer/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/php-api-clients/installer/?branch=master)\n[![License](https://poser.pugx.org/api-clients/installer/license.png)](https://packagist.org/packages/api-clients/installer)\n[![PHP 7 ready](http://php7ready.timesplinter.ch/php-api-clients/installer/badge.svg)](https://travis-ci.org/php-api-clients/installer)\n\n## Usage\n\n## require api-clients/installer\n\nAdd `api-clients/installer` to `require` of your `composer.json`.\n\n## post-create-project-cmd\n\nIt is recommended to use the following `post-create-project-cmd` script. This is the bare minimum require for the installer to work. [`api-clients/skeleton` for example also runs resource generation, code style fixes, and QA checks after install.](https://github.com/php-api-clients/skeleton/blob/30a2d61453a014052ab84ba11687d3cd5fe23a4f/composer.json#L97-L104):\n\n```json\n{\n\n    \"scripts\": {\n        \"post-create-project-cmd\": [\n            \"ApiClients\\\\Tools\\\\Installer\\\\Installer::postCreateProject\",\n            \"composer update --no-autoloader --ansi\",\n            \"composer update --ansi\"\n        ]\n    }\n}\n\n```\n\n## installer.yml\n\nCreate an `installer.yml` in the project root of the package you want to create use the installer for. The following configuration is from `api-clients/skeleton`:\n\n```yaml\npackage: api-clients/skeleton\ntext:\n  welcome: \"Welcome to the API Clients new client installer.\"\n  ascii_art_file:\n    - ascii.small.art\n    - ascii.medium.art\n    - ascii.large.art\n  ascii_art_package: api-clients/branding\nconfig:\n  current_ns: \"ApiClients\\\\Skeleton\"\n  current_ns_tests: \"ApiClients\\\\Tests\\\\Skeleton\"\n  require:\n    - installer\n    - installer-client-operations\n  scripts:\n    - post-create-project-cmd\nquestions:\n  author_name:\n    description: \"Author name\"\n    question: \"What is your name?\"\n  author_email:\n    description: \"Author email\"\n    question: \"What is your email address?\"\n    validate: \"Assert\\\\Assertion::email\"\n  package_name:\n    description: \"Your package\"\n    question: \"What is your package name?\"\n    default: \"vendor-name/package-name\"\n  path_src:\n    description: \"Your project sources location\"\n    question: \"What is your project sources location?\"\n    default: \"src/\"\n  path_tests:\n    description: \"Your project tests location\"\n    question: \"What is your project tests location?\"\n    default: \"tests/\"\n  ns_vendor:\n    description: \"Your namespace\"\n    question: \"What is your vendor namespace?\"\n    default: \"MyVendor\"\n  ns_tests_vendor:\n    description: \"Your test namespace\"\n    question: \"What is your vendor test namespace?\"\n    default: \"MyVendor\\\\Tests\"\n  ns_project:\n    description: \"Your project namespace\"\n    question: \"What is your project namespace?\"\n    default: \"MyProject\"\noperations:\n  - \"ApiClients\\\\Tools\\\\Installer\\\\Operation\\\\ComposerJson::create\"\n  - \"ApiClients\\\\Tools\\\\Installer\\\\Operation\\\\UpdateNamespaces::create\"\n```\n\nLets break that down and describe what each section does:\n\n### package\n\nThe name of the skeleton package.\n\n### text\n\nText options used to create a welcome at the start of the installer.\n\n##### text.welcome\n\nWelcome message.\n\n##### text.ascii_art_file\n\nArray with ASCII files. \n\n##### text.ascii_art_package\n\nASCII art package, if not provided the skeleton is searched for the ASCII art files.\n\n### config\n\nArray with additional configuration options.\n\n### questions\n\nThe questions asked used for gathering the information needed to perform the operations.\n\n### operations\n\nOperations run after all the questions have been answered.\n\n# License\n\nThe MIT License (MIT)\n\nCopyright (c) 2017 Cees-Jan Kiewiet\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphp-api-clients%2Finstaller","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphp-api-clients%2Finstaller","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphp-api-clients%2Finstaller/lists"}