diff --git a/README.md b/README.md index 0aa0cd7e..029fcf98 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,19 @@ # wiq_es6b +## Contributors +
+ +## Code Analysis + [![Deploy on release](https://github.com/Arquisoft/wiq_es6b/actions/workflows/release.yml/badge.svg)](https://github.com/Arquisoft/wiq_es6b/actions/workflows/release.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wiq_es6b&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wiq_es6b) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wiq_es6b&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wiq_es6b) @@ -11,6 +25,11 @@ This repo is a basic application composed of several components. - **Gateway service**. Express service that is exposed to the public and serves as a proxy to the two previous ones. - **User service**. Express service that handles the insertion of new users in the system. - **Auth service**. Express service that handles the authentication of users. +- **Create service**. Express service that, using some queries and the WikiData API, generates the questions and answers. +- **Question Generator service**. Express service that handles the storage of the generated questions and answers to use them in the games. +- **Generated Questions service**. Express service that stores every question and correct answer that has been shown during games (useful to list "Historial de Preguntas generadas" or "Generated Questions History"). +- **Record service**. Express service that handles the storage of the result of every game that has been played by a user. +- **Ranking service**. Express service that handles the storage of the statistics of every player since he/she created his/her account. - **Webapp**. React web application that uses the gateway service to allow basic login and new user features. Both the user and auth service share a Mongo database that is accessed with mongoose. @@ -111,4 +130,4 @@ This action uses three secrets that must be configured in the repository: - DEPLOY_USER: user with permission to execute the commands in the remote machine. - DEPLOY_KEY: key to authenticate the user in the remote machine. -Note that this action logs in the remote machine and downloads the docker-compose file from the repository and launches it. Obviously, previous actions have been executed which have uploaded the docker images to the GitHub Packages repository. +Note that this action logs in the remote machine and downloads the docker-compose file from the repository and launches it. Obviously, previous actions have been executed which have uploaded the docker images to the GitHub Packages repository. \ No newline at end of file