{"id":16193196,"url":"https://github.com/koriym/koriym.phpskeleton","last_synced_at":"2025-04-05T07:04:11.211Z","repository":{"id":1753871,"uuid":"2580843","full_name":"koriym/Koriym.PhpSkeleton","owner":"koriym","description":"CI ready PHP project skeleton","archived":false,"fork":false,"pushed_at":"2023-04-17T15:00:16.000Z","size":205,"stargazers_count":182,"open_issues_count":0,"forks_count":27,"subscribers_count":18,"default_branch":"1.x","last_synced_at":"2024-10-11T08:14:17.689Z","etag":null,"topics":["php","skeleton"],"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/koriym.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2011-10-15T07:40:11.000Z","updated_at":"2024-02-29T06:04:38.000Z","dependencies_parsed_at":"2023-07-05T19:33:11.945Z","dependency_job_id":null,"html_url":"https://github.com/koriym/Koriym.PhpSkeleton","commit_stats":{"total_commits":308,"total_committers":17,"mean_commits":18.11764705882353,"dds":"0.15909090909090906","last_synced_commit":"836b91ee4fbb2cf319003b3071b73d2f862a355f"},"previous_names":[],"tags_count":51,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koriym%2FKoriym.PhpSkeleton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koriym%2FKoriym.PhpSkeleton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koriym%2FKoriym.PhpSkeleton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koriym%2FKoriym.PhpSkeleton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koriym","download_url":"https://codeload.github.com/koriym/Koriym.PhpSkeleton/tar.gz/refs/heads/1.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247299831,"owners_count":20916190,"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","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":["php","skeleton"],"created_at":"2024-10-10T08:14:19.487Z","updated_at":"2025-04-05T07:04:11.178Z","avatar_url":"https://github.com/koriym.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# A standard PHP project skeleton\n\nAre you tired of copy-pasting your boilerplate PHP code whenever you need to start a new project?\n\nThis repository contains a single-line command that will automatically setup for you all the needed code to create a modern, clutter-free and test-oriented PHP package.\n\nIt will automatically install the following dependencies:\n\n* [PHPUnit](https://phpunit.readthedocs.io/ja/latest/): provides testing framework.\n* [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer/wiki): detects violations of a defined set of coding standards.\n* [PHPMD](https://phpmd.org): analyze your code to detect sub-optimal or overly complex code.\n* [PHPStan](https://phpmd.org): discover bugs in your code without running it.\n* [Psalm](https://psalm.dev): - another static analysis tool from Vimeo.\n* [PHPMetrics](https://www.phpmetrics.org) provides various metrics.\n* [ComposerRequireChecker](https://github.com/maglnet/ComposerRequireChecker) Check composer dependencies.\n\n## Project Structure\n\nAfter installation, your project will have the following structure:\n\n```\nyour-project/\n├── src/                 # Source code\n├── tests/               # Test files\n│   └── Fake/            # Test doubles\n├── vendor/              # Dependencies\n├── vendor-bin/          # Development tool dependencies\n├── build/               # Build artifacts (coverage reports, etc.)\n├── composer.json        # Project configuration\n├── phpcs.xml            # PHP_CodeSniffer configuration\n├── phpmd.xml            # PHPMD configuration\n├── phpstan.neon         # PHPStan configuration\n├── phpunit.xml.dist     # PHPUnit configuration\n├── psalm.xml            # Psalm configuration\n├── composer-require-checker.json  # Composer dependencies checker configuration\n└── README.md            # Project documentation\n```\n\n## Create Project\n\nTo create your project, enter the following command in your console:\n\n```\ncomposer create-project koriym/php-skeleton \u003cproject-path\u003e\n```\n\nYou will be asked a few questions to configure the project:\n\n```\nWhat is the vendor name ?\n(MyVendor):Koriym\n\nWhat is the package name ?\n(MyPackage):AwesomePackage\n\nWhat is your name ?\n(Akihito Koriyama):\n\nWhat is your email address ?\n(akihito.koriyama@gmail.com):\n```\n\n## Composer Commands\n\nOnce installed, the project will automatically be configured, so you can run these commands in the root of your application:\n\n### test\n\n`composer test` runs [`phpunit`](https://github.com/sebastianbergmann/phpunit).\n\n### tests\n\n`composer tests` runs `cs`, `sa`, and `test`.\n\n### coverage, phpdbg, pcov\n\n`composer coverage` builds a test coverage report using [XDebug](https://xdebug.org/).\n`composer phpdbg` builds a test coverage report using [phpdbg](https://www.php.net/manual/en/book.phpdbg.php).\n`composer pcov` builds a test coverage report using [pcov](https://github.com/krakjoe/pcov).\n\n### cs, cs-fix\n\n`composer cs` checks coding standard.\n`composer cs-fix` fixes the PHP code to match coding standards.\n\n### sa\n\n`composer sa` runs static code analysis tools (PHPStan and Psalm).\n\n### metrics\n\n`composer metrics` generates code quality [metrics](https://www.phpmetrics.org).\n\n### build\n\n`composer build` builds all reports (code quality, test coverage, require check, metrics).\n\n## Continuous Integration\n\nThis project includes several GitHub Actions workflows to ensure code quality and compatibility. These workflows are pre-configured for common PHP project needs, but feel free to modify or remove them to suit your project's requirements.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoriym%2Fkoriym.phpskeleton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoriym%2Fkoriym.phpskeleton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoriym%2Fkoriym.phpskeleton/lists"}