Documentation
continuous-integration/drone/push Build is passing Details

pull/10/head
Victor Perez NGOUNOU 2 years ago
parent 18c3c1e9a9
commit e390b63c0b

@ -12,30 +12,26 @@
[![Vulnerabilities](https://codefirst.iut.uca.fr/sonar/api/project_badges/measure?project=BowlingScoreApp&metric=vulnerabilities&token=d89d41f6a247037395d41fe6f40f53a402943bd9)](https://codefirst.iut.uca.fr/sonar/dashboard?id=BowlingScoreApp) [![Vulnerabilities](https://codefirst.iut.uca.fr/sonar/api/project_badges/measure?project=BowlingScoreApp&metric=vulnerabilities&token=d89d41f6a247037395d41fe6f40f53a402943bd9)](https://codefirst.iut.uca.fr/sonar/dashboard?id=BowlingScoreApp)
# BowlingScoreApp # Bowling Score API
Welcome on the BowlingScoreApp project!
<img src="Documentation/doc_images/bowling-157933.png" height=40/> <img src="Documentation/doc_images/bowling-157933.png" height=40/>
## Description ## Description
Ce projet est une application de gestion de score de bowling. Cette API fournit des services pour gérer les scores d'un jeu de bowling.
l'application vas permettre de: Elle permet de créer des joueurs, des parties et de gérer les scores de chaque joueur pour chaque partie.
Elle permet également de consulter les scores de chaque joueur pour chaque partie.
* Gérer les scores de plusieurs joueurs en même temps. Le projet est développé en C# avec le framework .NET Core 6.0.
* Gérer les matchs en équipe, en individuel ou en solo. la documentation de l'API est disponible à l'adresse suivante : https://codefirst.iut.uca.fr/swagger/index.html
* consulter les statistiques des joueurs. et est constituée de 2 API (API RestFull et GraphQL) qui qui sont manager par une API Gateway.
* consulter les statistiques des matchs.
* Consulter l'historique des matchs.
## Installation ## Installation
### Requirements ### Requirements
* C# 8.0 * C# 10.0
* .NET Core 6.0 * .NET Core 6.0
* Visual Studio 2022 * Visual Studio 2022
* Entity Framework Core 6.0 * Entity Framework Core 6.0
@ -44,7 +40,7 @@ l'application vas permettre de:
### Clone ### Clone
Clone this repo to your local machine using `https://codefirst.iut.uca.fr/git/victor_perez.ngounou/BowlingScoreApp.git` Clone this repo to your local machine using 'https://codefirst.iut.uca.fr/git/victor_perez.ngounou/ApiBowlingProject.git'
* [Git](https://git-scm.com) - Download and Install Git. * [Git](https://git-scm.com) - Download and Install Git.
* [Visual Studio](https://visualstudio.microsoft.com/fr/) - Download and Install Visual Studio. * [Visual Studio](https://visualstudio.microsoft.com/fr/) - Download and Install Visual Studio.
@ -61,14 +57,11 @@ $ dotnet tool install --global dotnet-ef
### Setup ### Setup
* Ouvrir le projet dans Visual Studio. * Ouvrir le projet dans Visual Studio.
* Lancez le projet en mode debug. * Configurer l'exécution de l'application en mode "Multiple startup projects" et sélectionner les projets suivants :
* Dans le menu déroulant, sélectionnez "BowlingApp" puis "Package Manager Console". * BowlingApi
* Dans la console, tapez la commande suivante: * Bowling Api Gateway
* GraphQL Project
```shell * Build le projet.
$ dotnet ef database update
```
* L'application est prête à être utilisée. * L'application est prête à être utilisée.
## Usage ## Usage
@ -81,7 +74,6 @@ $ dotnet ef database update
* [Victor Perez NGOUNOU](https://codefirst.iut.uca.fr/git/victor_perez.ngounou) * [Victor Perez NGOUNOU](https://codefirst.iut.uca.fr/git/victor_perez.ngounou)
* [Mamadou Elaphi ARAFA](https://codefirst.iut.uca.fr/git/mamadou_elaphi.arafa) * [Mamadou Elaphi ARAFA](https://codefirst.iut.uca.fr/git/mamadou_elaphi.arafa)
* [Augustin AFFOGNON](https://codefirst.iut.uca.fr/git/augustin.affognon)
## Support ## Support

@ -4,7 +4,7 @@
"windowsAuthentication": false, "windowsAuthentication": false,
"anonymousAuthentication": true, "anonymousAuthentication": true,
"iisExpress": { "iisExpress": {
"applicationUrl": "http://localhost:47947", "applicationUrl": "https://localhost:47947",
"sslPort": 44397 "sslPort": 44397
} }
}, },

@ -1,7 +1,7 @@
{ {
"Routes": [ "Routes": [
{ {
"DownstreamPathTemplate": "/api/joueur", "DownstreamPathTemplate": "/api/v1/joueur",
"DownstreamScheme": "https", "DownstreamScheme": "https",
"DownstreamHostAndPorts": [ "DownstreamHostAndPorts": [
{ {
@ -9,12 +9,36 @@
"Port": 5001 "Port": 5001
} }
], ],
"UpstreamPathTemplate": "/rest/joueur", "UpstreamPathTemplate": "/rest/v1/joueur",
"UpstreamHttpMethod": [ "Get", "Post" ] "UpstreamHttpMethod": [ "Get", "Post" ]
}, },
{
"DownstreamPathTemplate": "/api/v1/joueur/{id}",
"DownstreamScheme": "https",
"DownstreamHostAndPorts": [
{
"Host": "localhost",
"Port": 5001
}
],
"UpstreamPathTemplate": "/rest/v1/joueur/{id}",
"UpstreamHttpMethod": [ "Put", "Delete" ]
},
{
"DownstreamPathTemplate": "/api/v2/joueur/{pseudo}",
"DownstreamScheme": "https",
"DownstreamHostAndPorts": [
{
"Host": "localhost",
"Port": 5001
}
],
"UpstreamPathTemplate": "/rest/v2/joueur/{pseudo}",
"UpstreamHttpMethod": [ "Get" ]
},
{ {
"DownstreamPathTemplate": "/graphql", "DownstreamPathTemplate": "/graphql",
"DownstreamScheme": "http", "DownstreamScheme": "https",
"DownstreamHostAndPorts": [ "DownstreamHostAndPorts": [
{ {
"Host": "localhost", "Host": "localhost",

Loading…
Cancel
Save