PHPackages                             phoneburner/pinch-template - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Templating & Views](/categories/templating)
4. /
5. phoneburner/pinch-template

AbandonedProject[Templating & Views](/categories/templating)

phoneburner/pinch-template
==========================

The Pinch Application Template

v0.0.36(7mo ago)012MITPHPPHP ^8.4CI passing

Since Aug 8Pushed 7mo agoCompare

[ Source](https://github.com/phoneburner/pinch-template)[ Packagist](https://packagist.org/packages/phoneburner/pinch-template)[ RSS](/packages/phoneburner-pinch-template/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (13)Versions (21)Used By (0)

\[READ ONLY\] Pinch Framework: API Application Template
=======================================================

[](#read-only-pinch-framework-api-application-template)

> **Note:** This repository is a **read-only** subtree split of the [Pinch Framework monorepo](https://github.com/phoneburner/pinch). Please submit issues and pull requests to the main repository.

About
-----

[](#about)

The Pinch Template package provides a complete application starter template for building REST APIs with the Pinch Framework. This opinionated template includes pre-configured Docker setup, database migrations, testing infrastructure, and example implementations following the framework's type-safe, API-first philosophy.

Quick Start
-----------

[](#quick-start)

### Create a New Project

[](#create-a-new-project)

```
composer create-project phoneburner/pinch-template my-api
cd my-api
```

### Initial Setup

[](#initial-setup)

1. **Configure Environment**

    ```
    cp .env.dist .env
    # Edit .env with your configuration
    ```
2. **Build Docker Images and Install Dependencies**

    ```
    make
    ```
3. **Start Docker Services**

    ```
    docker compose up -d
    ```
4. **Run Database Migrations**

    ```
    docker compose run --rm php pinch migrations:migrate
    ```
5. **Verify Installation**

    ```
    curl http://localhost:8080/
    ```

Project Overview
----------------

[](#project-overview)

```
my-api/
├── bin/               # Console commands
├── config/            # Configuration files
├── database/          # Database migrations
├── public/            # Web root
├── src/               # Application source code
├── tests/             # Test suites
├── storage/           # Cache and logs
├── .env.dist          # Environment template
├── composer.json      # Project Composer dependencies
├── compose.yaml       # Docker Compose configuration
├── Makefile           # Development commands
└── openapi.yaml       # API specification

```

Development
-----------

[](#development)

### Common Commands

[](#common-commands)

```
# Run tests
make test

# Code quality checks
make lint
make phpstan
```

Documentation
-------------

[](#documentation)

- [Main Framework Documentation](https://github.com/phoneburner/pinch)
- [API Design Guidelines](https://github.com/phoneburner/pinch/blob/main/docs/api-design.md)
- [Testing Best Practices](https://github.com/phoneburner/pinch/blob/main/docs/testing.md)
- [Security Considerations](https://github.com/phoneburner/pinch/blob/main/docs/security.md)

Troubleshooting
---------------

[](#troubleshooting)

### Common Issues

[](#common-issues)

**Docker services not starting:**

```
docker compose down -v
docker compose up -d
```

**Permission issues:**

```
docker compose exec php chown -R www-data:www-data var/
```

**Database connection errors:**

- Verify `.env` database settings
- Check Docker network: `docker compose ps`
- Verify database service: `docker compose logs db`

Contributing
------------

[](#contributing)

This is a read-only repository. To contribute:

1. Visit the [main repository](https://github.com/phoneburner/pinch)
2. Submit issues and pull requests there
3. Follow the contribution guidelines in the main repository

License
-------

[](#license)

The Pinch Framework is open-source software licensed under the [MIT license](https://github.com/phoneburner/pinch/blob/main/LICENSE).

###  Health Score

35

—

LowBetter than 79% of packages

Maintenance69

Regular maintenance activity

Popularity5

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~3 days

Recently: every ~12 days

Total

20

Last Release

212d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/7ecc476ac18daccbca443ff60a1a3a58d213617e7954eb9511d63c685a7c4c3d?d=identicon)[kevinreeves](/maintainers/kevinreeves)

---

Top Contributors

[![actions-user](https://avatars.githubusercontent.com/u/65916846?v=4)](https://github.com/actions-user "actions-user (32 commits)")

###  Code Quality

TestsPHPUnit

Static AnalysisRector

### Embed Badge

![Health badge](/badges/phoneburner-pinch-template/health.svg)

```
[![Health](https://phpackages.com/badges/phoneburner-pinch-template/health.svg)](https://phpackages.com/packages/phoneburner-pinch-template)
```

###  Alternatives

[mustache/mustache

A Mustache implementation in PHP.

3.3k44.6M291](/packages/mustache-mustache)[roots/acorn

Framework for Roots WordPress projects built with Laravel components.

9682.1M97](/packages/roots-acorn)[whitecube/nova-flexible-content

Flexible Content & Repeater Fields for Laravel Nova.

8053.0M25](/packages/whitecube-nova-flexible-content)[mopa/bootstrap-bundle

Easy integration of twitters bootstrap into symfony2

7042.9M33](/packages/mopa-bootstrap-bundle)[limenius/react-bundle

Client and Server-side react rendering in a Symfony Bundle

3871.2M](/packages/limenius-react-bundle)[nicmart/string-template

StringTemplate is a very simple string template engine for php. I've written it to have a thing like sprintf, but with named and nested substutions.

2101.7M30](/packages/nicmart-string-template)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)