thomasMagalhaes30 / AluilCine

4 stars 0 forks source link

AluilCine

AluilCine est un projet de Licence Pro de l'IUT Clermont-Ferrand 2022. (Période 3 - Client Serveur)

⚠ Le projet doit être rendu pour le vendredi 24 juin 2022 minuit !

Liens utiles

Installation

⚠ Dans le repertoire du projet

Télécharger les dépendances

mvn clean install

ou

./mvnw clean install

Configurer le .env à partir du .env.sample

cp .env.sample .env

Lancement

⚠ Dans le repertoire du projet

Lancer le projet spring boot

mvn spring-boot:run

ou

./mvnw spring-boot:run

Informations & documentation

Les diiférents point d'évaluations sont justifié dans les issues qui ont certainnes Milestones

Structure

Tableaux

CRUD

Chaque entité a un CRUD associé grâce à l'extends de BaseController

Les collections disponibles, sont :

Verbe Route API Definition
GET /{nomDeLaCollection} Obtenir toutes les documents d'une collection
GET /{nomDeLaCollection}/{id} Obtenir un document d'une collection selon son ID
POST /{nomDeLaCollection} Ajouter un document dans la collection (les champs sont en camelcase)
PUT /{nomDeLaCollection}/{id} Modifier un document
DELETE /{nomDeLaCollection}/{id} Supprimer un document

MovieController

Verbe Route API Paramètre de requête Exemple
GET /movies/pageableByMark{number} number le nombre de movie souhaités sur la page. un paramètre optionnel page existe, il permet d'obtenir les films selon une pagination, un entier est attendu pour se paramètre. /movies/pageableByMark10?page=2
GET /movies/last{number}MovieReleased/ retourne une liste des derniers film sorti en fonction du number, sachant que le number doit être compris de 1 à 20 /movies/last10MovieReleased
GET /movies/pageableByCategory/{category} Obtenir les films pour une catégorie donnée, paramètre page pour obtenir la page de la pagination avec le paramètre numberOfMovieByPage qui indique le nombre de films par page /movies/pageableByCategory/Action?page=2&numberOfMovieByPage=6
GET /movies/markAvgByCategory retourne la note moyenne des films par catégorie /movies/markAvgByCategory
GET /movies/searchByTitle/{searchTitle} retourne les films qui contiennent seachTitle dans leur titre /movies/searchByTitle/toto

CinemaController

Verbe Route API Paramètre de requête
GET /cinemas/location latitude, longitude et limit, limit pour la quantité de documents retournés

MovieSessionController

Verbe Route API Paramètre de requête
GET /movieSessions/condition/ day, cinemaId et movieId, le day est au format (dd-MM-yyyy) comme (23-08-2022)

ReviewController

Verbe Route API Paramètre de requête
GET /reviews/pageableByMovieId/ movieId, page : Integer, numberOfReviewsByPage : Integer - page et numberOfReviewsByPage sont optionnels

Auteurs

Technologies et outils

<img style="height:64px; padding-right:16px;" align="left" src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/git/git-original.svg" alt="logo git"/> <img style="height:64px; padding-right:16px;" align="left" src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/spring/spring-original-wordmark.svg" alt="logo spring boot"/> <img style="height:64px; padding-right:16px;" align="left" src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/mongodb/mongodb-original-wordmark.svg" alt="logo mongodb"/>