This commit is contained in:
Jérémy Guillot
2024-06-03 17:36:22 +02:00
commit bddcdd6823
73 changed files with 13150 additions and 0 deletions

53
README.md Normal file
View File

@@ -0,0 +1,53 @@
# Projet TKM Symfony
Ce projet est un fork du template Symfony disponible à [dunglas/symfony-docker](https://github.com/dunglas/symfony-docker), adapté aux besoins spécifiques de TKM. Il intègre Symfony 7.0.2 et est configuré pour fonctionner avec Docker, offrant une mise en place rapide et efficace pour le développement.
## Prérequis
Avant de commencer, assurez-vous que les outils suivants sont installés sur votre machine :
- Docker
- Makefile
## Installation
Pour mettre en place le projet, suivez ces étapes :
1. Clonez le dépôt du projet :
```git clone git@bitbucket.org:tkm_rd/tkm-symfony.git```
2. Copiez le fichier `.env.example` en `.env` :
```cp .env.example .env```
3. Modifiez les credentials dans le fichier `.env` selon vos besoins.
4. Lancez l'installation des dépendances et la configuration du projet :
```make install```
Si vous rencontrez des problèmes de droits sur le projet, exécutez :
```make fix-permissions```
## Utilisation
Pour démarrer le projet, utilisez :
```make start```
Pour arrêter le projet, utilisez :
```make stop```
Pour voir d'autres commandes utiles, vous pouvez lancer :
```make help```
## Composants
Le projet comprend les technologies et outils suivants :
- **Symfony 7.0.2** : Framework PHP pour la construction d'applications web.
- **PostgreSQL 16** : Système de gestion de base de données relationnelle.
- **Caddy** : Serveur web moderne, sécurisé et facile à utiliser.
- **FrankenPhp** : Environnement d'exécution pour applications PHP.
- **phpmd (PHP Mess Detector)** : Outil d'analyse statique de code PHP.
- **php-cs (PHP CodeSniffer)** : Outil pour détecter les violations de standards de codage PHP.
## Administration de la Base de Données
Admirer, équivalent de PhpMyAdmin, est disponible sur le port **8080** pour la gestion de la base de données. Les credentials sont spécifiés dans le fichier `.env`. Utilisez `database` comme nom de serveur, qui correspond au nom du conteneur Docker de la base de données.