Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved the readme #144

Merged
merged 1 commit into from
Apr 27, 2024
Merged

Improved the readme #144

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions README.md
View file
Open in desktop
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