Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/keinos/tpl-php-helloworld

✅ Overly-super-cautious "Hello World" in PHP7 and PHP8 for fun.
https://github.com/keinos/tpl-php-helloworld

cis composer coveralls docker fun php php8 template-project travis

Last synced: about 1 month ago
JSON representation

✅ Overly-super-cautious "Hello World" in PHP7 and PHP8 for fun.

Host: GitHub
URL: https://github.com/keinos/tpl-php-helloworld
Owner: KEINOS
License: apache-2.0
Created: 2020-02-13T09:17:42.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2021-01-01T05:53:35.000Z (about 4 years ago)
Last Synced: 2024-10-29T08:04:40.901Z (3 months ago)
Topics: cis, composer, coveralls, docker, fun, php, php8, template-project, travis
Language: Shell
Homepage:
Size: 11.5 MB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Build Status](https://travis-ci.com/KEINOS/TPL-PHP-HelloWorld.svg?branch=master)](https://travis-ci.com/KEINOS/TPL-PHP-HelloWorld/builds)

[![Coverage Status](https://coveralls.io/repos/github/KEINOS/TPL-PHP-HelloWorld/badge.svg)](https://coveralls.io/github/KEINOS/TPL-PHP-HelloWorld)

[![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")

[![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")

# Super cautious "Hello-World"

This 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!".

## Tests

- Supported PHP Version to test

  - PHP v7.1, 7.2, 7.3, 7.4, 8.0 (, nightly)

  - Details see: [.travis.yml](./.travis.yml)

    - Note: The nightly build version (PHP8-dev) might fail in TravisCI.

- Unit Test & Code Coverage

  - [PHPUnit](https://phpunit.de/)

- Coding Standard Compliance

  - [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) (PSR-2, PSR-12)

  - [PHP Mess Detector](https://phpmd.org/) (Avoid complexity)

- PHP Static Analysis

  - [PHPStan](https://github.com/phpstan/phpstan)

  - [PSalm](https://psalm.dev/)

  - [Phan](https://github.com/phan/phan)

- Benchmark

  - [PHPBench](https://github.com/phpbench/phpbench)

- Docker for Local Testing

  - Details see: [docker-compose.yml](./docker-compose.yml)

## CIs Used

This repo uses the following CIs. On your use, register your repo first.

- [TravisCI](https://travis-ci.org/): Used for running tests.

- [COVERALLS](https://coveralls.io/): Used for code coverage.

- [Scrutinizer CI](https://scrutinizer-ci.com/): Used for code quality.

# Using this package as a template/boilerplate

How to





## How to use it as a template

### TL; DR

Copy, initialize the project, smoke test, add CI's ACCESS TOKEN then you're redy-to-go!

### TS; DR

1. Create a new copy.

    Choose one of the below commands that suits you.

    - Note that you need to specify your project's name. This will be your "package name" as well.

    ```bash

    # For composer user with NO Docker

    composer create-project keinos/hello-world-tpl MyNewProject

    cd MyNewProject

    ```

    ```bash

    # For Docker and docker-compose user (No PHP nor composer user)

    git clone https://github.com/KEINOS/TPL-PHP-HelloWorld.git MyNewProject

    cd MyNewProject

    ```

2. Initialize.

    Run the command below to initialize your project. This will re-write the package and vendor names to the provided name. (Ex. MyVendorName)

    ```bash

    rm -rf .git

    git init

    ./.devcontainer/initialize_package.php MyVendorName

    ```

3. Functioning test.

    Before anything, run the tests to check it's basic test functionality.

    ```bash

    composer test -- --all --verbose

    ```

4. Initial commit.

    Commit your first change.

    ```bash

    git add .

    git commit -m 'initial commit'

    ```

5. Push the repo to GitHub then register it to the following CIs.

    - [TravisCI](https://travis-ci.org/)

    - [COVERALLS](https://coveralls.io/)

6. Re-name `COVERALLS.env.sample` to `COVERALLS.env` under `./tests/conf`.

7. Get your access token from COVERALLS' settings and place/replace the token value in `COVERALLS.env`.

8. Run tests again to see COVERALLS' function-ability.

9. If the local test passes then commit changes and push.

10. If the tests passes on CIs then start building your project.

## Developing via Docker

This repo can be developed via Docker. Run:

```bash

composer dev

```

Or, if you use Visual Studio Code (a.k.a. VS Code) and have Docker, then **"Remote - Containers" extension** is available.

In this case, you don't need to install the packages or even PHP on your local env.

1. Install Microsoft's ["Remote - Containers"](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension to your VS Code.

2. `git clone` this repo to your local.

3. Remove the `.git` directory and initialize as a new one by `git init`.

4. Open folder in a Container by: F1 -> "Remote-Containers: Reopen in Container".



## Credit

This repo was very much inspired by:

- [このPHPがテンプレートエンジンのくせに慎重すぎる](https://qiita.com/search?utf8=%E2%9C%93&sort=&q=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