Merge pull request #8 from thomas-claireau/create-uml-diagrams

add uml diagrams -> use case and sequence

Author: imtomdev

.gitignore

@@ -1,8 +1,15 @@
 wireframes.pdf
 CDC.pdf
+deploy
 
 # Public image
-public/images/figures
+public/images/figures/*
+!public/images/fixtures/image-1.jpg
+!public/images/fixtures/image-2.jpg
+!public/images/fixtures/image-3.jpg
+!public/images/fixtures/image-4.jpg
+!public/images/fixtures/image-5.jpg
+!public/images/fixtures/image-6.jpg
 
 # Files ignored
 composer.lock

README.md

@@ -1,9 +1,64 @@
 # [PHP] - P6 Openclassrooms - Développez de A à Z le site communautaire SnowTricks
 
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/38908a1ea0204cd39996400db31ba8eb)](https://www.codacy.com/manual/thomas-claireau/PHP-P6-Openclassrooms?utm_source=github.com&utm_medium=referral&utm_content=thomas-claireau/PHP-P6-Openclassrooms&utm_campaign=Badge_Grade)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/38908a1ea0204cd39996400db31ba8eb)](https://www.codacy.com/manual/thomas-claireau/PHP-P6-Openclassrooms?utm_source=github.com&utm_medium=referral&utm_content=thomas-claireau/PHP-P6-Openclassrooms&utm_campaign=Badge_Grade)
 
 [![Maintainability](https://api.codeclimate.com/v1/badges/56882df21a146f2e28bf/maintainability)](https://codeclimate.com/github/thomas-claireau/PHP-P6-Openclassrooms/maintainability)
 
+Démo du projet, [c'est par ici 👋](http://snowtricks.thomas-claireau.fr/)
+
+## Installation du projet
+
+Via Composer :
+
+```text
+composer create-project thomas-claireau/snowtricks:dev-master
+```
+
+Dans le cas où vous téléchargez directement le projet (ou encore avec `git clone`), effectuez un `composer install` à la racine du projet.
+
+Installez ensuite les dépendances front du projet. Placez-vous à la racine du projet :
+
+```text
+npm install
+```
+
+### Remarque
+
+#### Accès base de données
+
+Le projet est livré sur Packagist sans base de données. Cela signifie qu'il faut que vous ajoutiez votre configuration, dans le fichier `.env`, dans la partie `DATABASE_URL`.
+
+#### Injection SQL et structure du projet
+
+Pour obtenir une structure similaire à mon projet au niveau de la base de données, je vous joins aussi dans le dossier `~src/Migrations/` les versions de migrations que j'ai utilisées. Vous pouvez donc recréer la base de données en effectuant la commande suivante, à la racine du projet :
+
+```text
+php bin/console doctrine:migrations:migrate
+```
+
+Après avoir créer votre base de données, vous pouvez également injecter un jeu de données en effectuant la commande suivante :
+
+```text
+php bin/console doctrine:fixtures:load
+```
+
+### Lancer le projet
+
+A la racine du projet :
+
+-   Pour lancer le serveur de développement, effectuez un `npm run dev-server`.
+-   Pour lancer le serveur de symfony, effectuez un `php bin/console server:run`.
+
+### Site en production
+
+Pour voir une version du site en production, suivez l'[url suivante](http://snowtricks.thomas-claireau.fr/).
+
+### Envoi des mails
+
+Si vous souhaitez utiliser un serveur de mail afin d'envoyer des mails, vous pouvez le configurer dans le fichier `.env` à la racine du projet, dans la partie `MAILER_URL`
+
+Sachez que vous pouvez aussi utiliser [maildev](https://www.npmjs.com/package/maildev) pour simuler l'envoi des mails.
+
 ## Contexte
 
 Jimmy Sweat est un entrepreneur ambitieux passionné de snowboard. Son objectif est la création d'un site collaboratif pour faire connaitre ce sport auprès du grand public et aider à l'apprentissage des figures (tricks).
@@ -14,18 +69,18 @@ Pour ce projet, nous allons nous concentrer sur la création technique du site p
 
 ## Description du besoin
 
-Vous êtes chargé de développer le site répondant aux besoins de Jimmy. Vous devez ainsi implémenter les fonctionnalités suivantes : 
+Vous êtes chargé de développer le site répondant aux besoins de Jimmy. Vous devez ainsi implémenter les fonctionnalités suivantes :
 
-- un annuaire des figures de snowboard. Vous pouvez vous inspirer de la liste des figures sur Wikipédia. Contentez-vous d'intégrer 10 figures, le reste sera saisi par les internautes ;
-- la gestion des figures (création, modification, consultation) ;
-- un espace de discussion commun à toutes les figures.
+-   un annuaire des figures de snowboard. Vous pouvez vous inspirer de la liste des figures sur Wikipédia. Contentez-vous d'intégrer 10 figures, le reste sera saisi par les internautes ;
+-   la gestion des figures (création, modification, consultation) ;
+-   un espace de discussion commun à toutes les figures.
 
 Pour implémenter ces fonctionnalités, vous devez créer les pages suivantes :
 
-- la page d’accueil où figurera la liste des figures ; 
-- la page de création d'une nouvelle figure ;
-- la page de modification d'une figure ;
-- la page de présentation d’une figure (contenant l’espace de discussion commun autour d’une figure).
+-   la page d’accueil où figurera la liste des figures ;
+-   la page de création d'une nouvelle figure ;
+-   la page de modification d'une figure ;
+-   la page de présentation d’une figure (contenant l’espace de discussion commun autour d’une figure).
 
 ## Nota Bene
 
@@ -37,6 +92,6 @@ Le design du site web est laissé complètement libre, attention cependant à re
 
 En premier lieu il vous faudra écrire l’ensemble des issues/tickets afin de découper votre travail méthodiquement et vous assurer que l’ensemble du besoin client soit bien compris avec votre mentor. Les tickets/issues seront écrits dans un repository Github que vous aurez créé au préalable.
 
-L’ensemble des figures de snowboard doivent être présentes à l’initialisation de l’application web. Vous utiliserez un bundle externe pour charger ces données. 
+L’ensemble des figures de snowboard doivent être présentes à l’initialisation de l’application web. Vous utiliserez un bundle externe pour charger ces données.
 
 ## ⌛ Projet en cours...

assets/css/app.scss

@@ -22,6 +22,10 @@ h1 {
 	}
 }
 
+.hide {
+	display: none;
+}
+
 .lead {
 	font-size: 1.75rem;
 

assets/images/image-1.jpg

@@ -48,3 +48,16 @@ $('.scroll').on('click', function(event) {
 $(document).ready(function() {
 	$('select').select2();
 });
+
+document.onreadystatechange = function() {
+	if (document.readyState == 'complete') {
+		// ===== FOOTER TOUJOURS EN BAS DE L'ECRAN ===== //
+		const footer = document.querySelector('footer');
+
+		if (footer) {
+			var heightFooter = document.querySelector('footer').offsetHeight;
+			var contentPage = document.querySelector('#page-body');
+			contentPage.style.minHeight = 'calc(100vh - ' + heightFooter + 'px)';
+		}
+	}
+};