Squelette projet PHP

Version imprimable

12/05/2022, 15h58
grunk

Squelette projet PHP
Salut à tous,

je vous propose une base pour débuter proprement n'importe quel projet PHP (hors framework).

Il suffit de récupérer le projet ici : https://github.com/grunk/php-skeleton et de lancer un composer install.

Le projet s'articule autour de 3 dossiers :
- public : c'est ici que devra pointer votre virtual host ouracine web , c'est le seul dossier exposé à "internet". C'est ici qu'il faudra avoir un index.php , vos images , vos css , etc ...
- src : Les sources de votre application à organiser comme bon vous semble. Par défaut un namespace App pointe dans ce dossier.
- test: Dossier pour tests unitaires.
Il embarque les outils nécessaire à la production de code de qualité à savoir :
- PHPUnit pour les test
- PHPCS pour le style de code
- PHPStan pour l'analyse statique
Le projet est configuré avec plusieurs commandes prédéfinies pour utiliser ces outils :
- composer style vérifie le style du code en respect du PSR12
- composer style-fix corrige automatiquement les erreurs de style
- composer phpunit Lance les tests unitaires
- composer phpstan Lance une analyse statique
- composer test Regroupe toutes les commandes précédentes (utile pour CI/CD)
Pour finir un workflow basique de CI/CD est intégré avec les Github Actions. A chaque commit sur main l'ensemble des tests sont lancés automatiquement.

3 fichiers PHP sont dispo pour servir de démo, il est évidemment possible de les supprimer pour coller à votre besoin.

Mon but ici était de faire quelques chose de très simple et customisable tout en posant les bases des bonnes pratiques.
N'hésitez pas me donner vos avis sur la chose , d'éventuelles améliorations possible, etc...
12/05/2022, 16h55
laurentSc

Bonjour,

merci pour ta contribution.

J'ai voulu la tester. 1e remarque : si on ne connait pas composer (ça fait juste quelques mois que je connais), on peut pas savoir qu'il faut aller en invite de commandes à la racine du projet, pour y lancer composer install. Néanmoins, je savais qu'il fallait faire ça donc je l'ai fait. Ensuite, j'avais mis ce projet sur C:\projets\dvp\grunk. J'ai sur mon serveur local un virtual host qui pointe sur C:\projets\dvp (http://dev.dvp.fr). Donc je m'attendais à ce que l'URL http://dev.dvp.fr/grunk/public/index.php lance ton projet. Mais ça 5 minutes que ça mouline, donc y a un problème. Lequel ?

Mes questions :
1-

Citation:

public : c'est ici que devra pointer votre virtual host ouracine web

Il fallait pas plutôt écrire "sur la racine web" ?

2-

Citation:

Il embarque les outils nécessaire à la production de code de qualité à savoir :

PHPUnit pour les test
PHPCS pour le style de code
PHPStan pour l'analyse statique

Peux-tu dire ce que font ces 3 outils ?

3-

Citation:

Pour finir un workflow basique de CI/CD est intégré avec les Github Actions. A chaque commit sur main l'ensemble des tests sont lancés automatiquement.

Je ne connais pas du tout Github . Peux-tu expliquer ?
12/05/2022, 17h20
grunk

De part ca nature , ce "projet" s'adresse à des développeurs ayant un minimum de connaissance. Un débutant fera un projet basique sans se soucier des problématiques auquels réponds ce projet. D'où l'absence de détail sur composer.

Citation:

J'ai sur mon serveur local un virtual host qui pointe sur C:\projets\dvp (http://dev.dvp.fr). Donc je m'attendais à ce que l'URL http://dev.dvp.fr/grunk/public/index.php lance ton projet. Mais ça 5 minutes que ça mouline, donc y a un problème. Lequel ?

Comme expliqué dans mon premier message , le virtual host doit pointer dans le dossier public. Pas ailleurs.

Citation:

Peux-tu dire ce que font ces 3 outils ?

Je vois pas bien ce que je peux dire de plus que la description que j'en fais déjà :?

Citation:

Je ne connais pas du tout Github . Peux-tu expliquer ?

Github c'est un dépot git centralisé tout comme gitlab ou bitbucket. Les Github actions sont un outils d'intégration et déploiement continue permettant d'automatiser des taches comme les test, le déploiement , etc ...
15/05/2022, 15h48
laurentSc

Citation:

Envoyé par grunk

ce "projet" s'adresse à des développeurs ayant un minimum de connaissance

Après avoir passé un peu de temps sur ton projet, j'ai beau faire du PHP depuis 2007, je ne pense encore appartenir à cette catégorie :aie:

Citation:

Envoyé par grunk

Je vois pas bien ce que je peux dire de plus que la description que j'en fais déjà

J'avais pas vu...

Citation:

Envoyé par grunk

Github c'est un dépot git centralisé tout comme gitlab ou bitbucket. Les Github actions sont un outils d'intégration et déploiement continue permettant d'automatiser des taches comme les test, le déploiement , etc ...

Je connais un peu le principe de GitHub mais je connaissais pas les Github actions ni les CI/CD

Citation:

Envoyé par grunk

A chaque commit sur main l'ensemble des tests sont lancés automatiquement.

Ca ne parle pas, n'étant pas utilisateur de GitHub...