Tarot Scoreur

Build Status Bugs Code Smells Coverage Duplicated Lines (%) Maintainability Rating Quality Gate Status Reliability Rating Security Rating Technical Debt Vulnerabilities


The Tarot Scoreur application allows during your tarot games to automatically count the points of all the players in the game. With this application you can play online with your friend or play locally at your home !

Installation

Launch console app

  1. Move into Sources/TarotDb
  2. Create migration with the following command
    dotnet ef migrations add myFirstMigration
    
  3. Move into Sources/Tests/FT_TarotDb
    cd ..\Tests\FT_TarotDB\
    
  4. Create or update database with the following command
    dotnet ef database update --project ..\..\TarotDB\
    
  5. Run project FT_TarobDb with the following command
    dotnet run
    

Postman client

To configure a Postman client for the REST API and Gateway, follow these steps:

  1. Install Postman by following the instructions on the official Postman website.

  2. Open Postman and click on the "New" button on the top left to create a new request.

  3. Select the type of request you want to make (GET, POST, PUT, etc.).

  4. Enter the URL of the REST API or Gateway in the URL bar, for example :

    • REST API :
      https://codefirst.iut.uca.fr/containers/jordanartzet-tarot-rest-service/api/v{version}/users
      
    • Gateway :
      https://codefirst.iut.uca.fr/containers/jordanartzet-tarot-gateway-service/gateway/v{version}/users
      
  5. Replace {version} or any other parameter with its value. In our case it will be 1.

    • Create a variable in Postman by going to Environments. You can then use this variable to replace the parameters in the API addresses, as follows:

    • REST API:

      https://codefirst.iut.uca.fr/containers/jordanartzet-tarot-rest-service/api/v{{version}}/users
      
    • Gateway API:

      https://codefirst.iut.uca.fr/containers/jordanartzet-tarot-gateway-service/gateway/v{{version}}/users   
      
    • This will allow you to change the value of the "version" variable from within the environment without having to modify the requests individually.

  6. Click the "Send" button to send the request.

  7. The response will be displayed in the "Response" section below.

  8. You can save this request by clicking "Save" to use it later.

  9. You can now use Postman to make requests to the REST API and the Gateway. Note that you may need to add additional headers and options depending on the API documentation.

Examples

Here is some examples of what you can do with the application.

  • You can see who you are and your current games
  • You can start or create a new game.
  • You can add a new hand to your game.
  • You can see the ranking of all the players.
  • You can see your profile.

For more examples, please refer to the Wiki

Overall application architecture

For more details, please refer to the Wiki

Features

Online mode

This mode allow you to play online and share your scores and achievements of all the game you play.

Local mode

This mode allow you to play at your home and add your friends on your phone. Enjoy playing your tarot games with your friends at home !

Usage

To learn how to use our application you can read the user manual on the wiki.

Questions

For questions and support ask here.

Contributors

Samuel Sirven
Florent Marques
Julien THÊME
Jordan Artzet