Skip to content

Commit

Permalink
Improved the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
UO289845 committed Apr 27, 2024
1 parent 67c897f commit f27d6db
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,32 @@
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wiq_en1b&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wiq_en1b)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wiq_en1b&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wiq_en1b)

This is a base repo for the [Software Architecture course](http://arquisoft.github.io/) in [2023/2024 edition](https://arquisoft.github.io/course2324.html).
<b>To access the game simply follow the link [here](http://wiqen1b.serveminecraft.net:3000)</b><br>
The documentation of the system can be found [here](https://arquisoft.github.io/wiq_en1b/)<br>
And the API documentation can be seen [here](http://wiqen1b.serveminecraft.net:8000/api-doc/)<br>

![wiq-icon-improved](https://github.com/Arquisoft/wiq_en1b/assets/124193979/cfa27b39-d039-4502-9299-da424cd04151)

This repo is a basic application composed of several components.
## Application components

This repo is an application made from 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.
- **Webapp**. React web application that uses the gateway service to allow basic login and new user features.
- **Record service**. Express service that handles the game results of all the users and shows a ranking.
- **Webapp**. React web application that uses the gateway service to allow users to play the game, in addition to registering, logging in, view the ranking and much more.
- **Question generator**. Java application that generates questions from Wikidata which are later used in the game.
- **Question service**. Express service that handles the database (MongoDB) and retrieves the previously generated question to be used in the game.

Both the user and auth service share a Mongo database that is accessed with mongoose.
Both the <i>User service</i> and <i>Auth service</i> share a Mongo database that is accessed with mongoose. The <i>Question generator</i> and <i>Question service</i> also share a MongoDB connection.

## Quick start guide
In order to deployed it locally you can check out the docker configuration below:

### Using docker

The fastest way for launching this sample project is using docker. Just clone the project:
If you want to try it out by yourself, the fastest way for launching this project is using docker. Just clone the project:

```sh
git clone https://github.com/Arquisoft/wiq_en1b.git
Expand All @@ -33,9 +41,9 @@ and launch it with docker compose:
docker compose --profile dev up --build
```

### Deployed in Cloud
In order to view the application deploy in the cloud click [here](http://wiqen1b.serveminecraft.net:3000)
### Members
## Members

The members of the great team that made this incredible application.

- Lucía Ruiz Núñez [email protected]
- Mario Junquera Rojas [email protected]
Expand Down

0 comments on commit f27d6db

Please sign in to comment.