https://github.com/mteu/php-template

A rather basic template for the Project Builder, a powerful Composer package to create new project packages from templates
https://github.com/mteu/php-template

composer php template

Last synced: 3 months ago
JSON representation

A rather basic template for the Project Builder, a powerful Composer package to create new project packages from templates

• Host: GitHub
• URL: https://github.com/mteu/php-template
• Owner: mteu
• License: gpl-3.0
• Created: 2023-02-01T08:43:26.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-16T01:49:36.000Z (4 months ago)
• Last Synced: 2024-09-16T03:02:17.587Z (4 months ago)
• Topics: composer, php, template
• Language: Twig
• Homepage:
• Size: 381 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


# Project Builder Template

[![CGL](https://github.com/mteu/php-template/actions/workflows/cgl.yaml/badge.svg)](https://github.com/mteu/php-template/actions/workflows/cgl.yaml)

[![Latest Stable Version](http://poser.pugx.org/mteu/php-template/v)](https://packagist.org/packages/mteu/php-template)

[![License](http://poser.pugx.org/mteu/php-template/license)](LICENSE.md)

📦 [Packagist](https://packagist.org/packages/mteu/php-template) ·

💾 [Repository](https://github.com/mteu/php-template) ·

🪲 [Issue tracker](https://github.com/mteu/php-template/issues)



This is a framework-agnostic [Project Builder](https://github.com/CPS-IT/project-builder) template with a relatively basic initial setup. It facilitates a swift and easy-to-use creation

of Composer based PHP projects.

## 🚀 Features

* Static code analysis template with [PHPStan](https://phpstan.org/)

* Automatic code migration with [Rector](https://getrector.com/)

* Pre-defined GitHub actions for CGL and releases

## 🔥 Getting started

1. Create a new project:

   ```bash

   composer create-project cpsit/project-builder 

   ```

2. [Project Builder](https://github.com/CPS-IT/project-builder) will automatically fetch and list available templates on `Packagist.org`.

3. Select the package `mteu/php-template`.

   ![image](assets/template-selection.png)

4. Follow the instructions and answer a few questions and you're good to go.

> 💡 Please refer to the official Project Builder [documentation](https://project-builder.cps-it.de)

> to learn about alternative ways to create your project.

## 👩‍💻:🧑‍💻 Contribution

We welcome your feedback and ideas! One quick ask, though: Please do consult [`CONTRIBUTING.md`](CONTRIBUTING.md) before

proposing a PR. Thanks!

## 💛 Acknowledgement

This template is heavily based on the preparatory work done by [@eliashaeussler](https://github.com/eliashaeussler) and

me in the [TYPO3 Template Package](https://github.com/CPS-IT/typo3-project-template).

## ⭐ License

This project template is licensed under [GNU General Public License 3.0 (or later)](LICENSE.md).