Light

jeckel-lab / cookiecutter-php Goto Github PK

View Code? Open in Web Editor NEW

This project forked from jeromegamez/cookiecutter-php

0.0 0.0 0.0 100 KB

Cookiecutter template for new PHP projects.

License: ISC License

Shell 8.94% PHP 91.06%

cookiecutter-php's Introduction

Cookiecutter PHP

Cookiecutter template to kickstart new PHP projects.

🚀 Forked from the original PHP Cookicutter by Jérôme Gamez

Features

Automated Composer Setup
Testing setup with
- PHPStan
- PHPUnit
- Infection
- PHP-CS-Fixer
- PHP-MD
- ...
Ready-to-go GitHub Actions

Quickstart

Install Cookiecutter:

$ pip install -U cookiecutter
# Or, on a mac with Homebrew
$ brew install cookiecutter

Generate a new PHP project:

$ cookiecutter gh:Jeckel-Lab/cookiecutter-php

Demo

User config

If you use this (or other) Cookiecutters a lot, you can override the defaults by having a .cookiecutterrc file in your home directory:

default_context:
    full_name: "My full name"
    email: "[email protected]"
    github_username: "mygithubusername"
abbreviations:
    php: https://github.com/jeromegamez/cookiecutter-php

You can find more information at https://cookiecutter.readthedocs.io/en/latest/advanced/user_config.html

cookiecutter-php's People

Contributors

cookiecutter-php's Issues

Update actions

Add actions on test workflow :

phpcs
phpmd
composer require checker
security advisory

Add daily security check

Update actions/checkout to v4 in generated project

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Setup cache environment
        id: extcache

See dependapot PR Jeckel-Lab/etl#1

PHPMD allow StaticAccess

Change rules, allow StaticAccess :

    <rule ref="rulesets/cleancode.xml">
        <exclude name="StaticAccess" />
    </rule>

Update generate README file

Update generated README file with

a line that project has been generated from this repository
a line explaining that this is a work in progress project

Add mockery as base packages

Add Mockery in generated project in required-dev:

composer require --dev mockery/mockery

Before, make sure to find an easy way to mock final and/or readonly classes

Exclude JetBrains IDE files

Add JetBrains idea/ directory to the .gitignore file from the generated repository

Remove phpcs, keep only php-cs-fixer

PHPCS is not enough maintained and still does not support all php8.2 features (after a year)

Remove it and keep only php-cs-fixer as it does the same (and more)

Add missing file in generate .gitignore file

Rules to add in the .gitignore file of generated project:

.phpcs-cache

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.