{"id":15934618,"url":"https://github.com/keinos/tpl-php-helloworld","last_synced_at":"2025-07-02T07:06:41.893Z","repository":{"id":55446057,"uuid":"240220253","full_name":"KEINOS/TPL-PHP-HelloWorld","owner":"KEINOS","description":"✅   Overly-super-cautious \"Hello World\" in PHP7 and PHP8 for fun.","archived":false,"fork":false,"pushed_at":"2021-01-01T05:53:35.000Z","size":12023,"stargazers_count":2,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-02T07:06:40.756Z","etag":null,"topics":["cis","composer","coveralls","docker","fun","php","php8","template-project","travis"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KEINOS.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}},"created_at":"2020-02-13T09:17:42.000Z","updated_at":"2021-03-19T17:59:13.000Z","dependencies_parsed_at":"2022-08-15T00:30:38.877Z","dependency_job_id":null,"html_url":"https://github.com/KEINOS/TPL-PHP-HelloWorld","commit_stats":null,"previous_names":[],"tags_count":46,"template":true,"template_full_name":null,"purl":"pkg:github/KEINOS/TPL-PHP-HelloWorld","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KEINOS%2FTPL-PHP-HelloWorld","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KEINOS%2FTPL-PHP-HelloWorld/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KEINOS%2FTPL-PHP-HelloWorld/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KEINOS%2FTPL-PHP-HelloWorld/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KEINOS","download_url":"https://codeload.github.com/KEINOS/TPL-PHP-HelloWorld/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KEINOS%2FTPL-PHP-HelloWorld/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263091025,"owners_count":23412343,"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":["cis","composer","coveralls","docker","fun","php","php8","template-project","travis"],"created_at":"2024-10-07T03:20:21.358Z","updated_at":"2025-07-02T07:06:41.864Z","avatar_url":"https://github.com/KEINOS.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.com/KEINOS/TPL-PHP-HelloWorld.svg?branch=master)](https://travis-ci.com/KEINOS/TPL-PHP-HelloWorld/builds)\n[![Coverage Status](https://coveralls.io/repos/github/KEINOS/TPL-PHP-HelloWorld/badge.svg)](https://coveralls.io/github/KEINOS/TPL-PHP-HelloWorld)\n[![Code Quality](https://img.shields.io/scrutinizer/quality/g/KEINOS/TPL-PHP-HelloWorld/master)](https://scrutinizer-ci.com/g/KEINOS/TPL-PHP-HelloWorld/build-status/master \"Scrutinizer code quality\")\n[![Supported PHP Version](https://img.shields.io/packagist/php-v/keinos/hello-world-tpl)](https://github.com/KEINOS/TPL-PHP-HelloWorld/blob/master/.travis.yml \"Version Support\")\n\n# Super cautious \"Hello-World\"\n\nThis repo is an overly-cautious [Hello-World PHP script](./src/Main.php) for fun. It includes the following tests and CIs to just say \"Hello-World!\".\n\n## Tests\n\n- Supported PHP Version to test\n  - PHP v7.1, 7.2, 7.3, 7.4, 8.0 (, nightly)\n  - Details see: [.travis.yml](./.travis.yml)\n    - Note: The nightly build version (PHP8-dev) might fail in TravisCI.\n- Unit Test \u0026 Code Coverage\n  - [PHPUnit](https://phpunit.de/)\n- Coding Standard Compliance\n  - [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) (PSR-2, PSR-12)\n  - [PHP Mess Detector](https://phpmd.org/) (Avoid complexity)\n- PHP Static Analysis\n  - [PHPStan](https://github.com/phpstan/phpstan)\n  - [PSalm](https://psalm.dev/)\n  - [Phan](https://github.com/phan/phan)\n- Benchmark\n  - [PHPBench](https://github.com/phpbench/phpbench)\n- Docker for Local Testing\n  - Details see: [docker-compose.yml](./docker-compose.yml)\n\n## CIs Used\n\nThis repo uses the following CIs. On your use, register your repo first.\n\n- [TravisCI](https://travis-ci.org/): Used for running tests.\n- [COVERALLS](https://coveralls.io/): Used for code coverage.\n- [Scrutinizer CI](https://scrutinizer-ci.com/): Used for code quality.\n\n# Using this package as a template/boilerplate\n\n\u003cdetails\u003e\u003csummary\u003eHow to\u003c/summary\u003e\u003cdiv\u003e\u003cbr\u003e\n\n## How to use it as a template\n\n### TL; DR\n\nCopy, initialize the project, smoke test, add CI's ACCESS TOKEN then you're redy-to-go!\n\n### TS; DR\n\n1. Create a new copy.\n\n    Choose one of the below commands that suits you.\n\n    - Note that you need to specify your project's name. This will be your \"package name\" as well.\n\n    ```bash\n    # For composer user with NO Docker\n    composer create-project keinos/hello-world-tpl MyNewProject\n    cd MyNewProject\n    ```\n\n    ```bash\n    # For Docker and docker-compose user (No PHP nor composer user)\n    git clone https://github.com/KEINOS/TPL-PHP-HelloWorld.git MyNewProject\n    cd MyNewProject\n    ```\n\n2. Initialize.\n\n    Run the command below to initialize your project. This will re-write the package and vendor names to the provided name. (Ex. MyVendorName)\n\n    ```bash\n    rm -rf .git\n    git init\n    ./.devcontainer/initialize_package.php MyVendorName\n    ```\n\n3. Functioning test.\n\n    Before anything, run the tests to check it's basic test functionality.\n\n    ```bash\n    composer test -- --all --verbose\n    ```\n\n4. Initial commit.\n\n    Commit your first change.\n\n    ```bash\n    git add .\n    git commit -m 'initial commit'\n    ```\n\n5. Push the repo to GitHub then register it to the following CIs.\n\n    - [TravisCI](https://travis-ci.org/)\n    - [COVERALLS](https://coveralls.io/)\n\n6. Re-name `COVERALLS.env.sample` to `COVERALLS.env` under `./tests/conf`.\n\n7. Get your access token from COVERALLS' settings and place/replace the token value in `COVERALLS.env`.\n\n8. Run tests again to see COVERALLS' function-ability.\n\n9. If the local test passes then commit changes and push.\n\n10. If the tests passes on CIs then start building your project.\n\n## Developing via Docker\n\nThis repo can be developed via Docker. Run:\n\n```bash\ncomposer dev\n```\n\nOr, if you use Visual Studio Code (a.k.a. VS Code) and have Docker, then **\"Remote - Containers\" extension** is available.\n\nIn this case, you don't need to install the packages or even PHP on your local env.\n\n1. Install Microsoft's [\"Remote - Containers\"](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension to your VS Code.\n2. `git clone` this repo to your local.\n3. Remove the `.git` directory and initialize as a new one by `git init`.\n4. Open folder in a Container by: F1 -\u003e \"Remote-Containers: Reopen in Container\".\n\n\u003c/div\u003e\u003c/details\u003e\n\n## Credit\n\nThis repo was very much inspired by:\n\n- [このPHPがテンプレートエンジンのくせに慎重すぎる](https://qiita.com/search?utf8=%E2%9C%93\u0026sort=\u0026q=title%3A%E3%81%93%E3%81%AEPHP%E3%81%8C%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC%E3%83%88%E3%82%A8%E3%83%B3%E3%82%B8%E3%83%B3%E3%81%AE%E3%81%8F%E3%81%9B%E3%81%AB%E6%85%8E%E9%87%8D%E3%81%99%E3%81%8E%E3%82%8B) @ Qiita\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeinos%2Ftpl-php-helloworld","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeinos%2Ftpl-php-helloworld","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeinos%2Ftpl-php-helloworld/lists"}