README.md

KWÌZØS

Pour jouer, rendez-vous sur https://kwisos.servegame.com/

En raison d'un problème de sockets sur le vps qui héberge le site, les modes timer, scrum et team sont à tester en localhost

Introduction

KWÌZØS est une application de quiz interactive qui permet aux utilisateurs de jouer à des quiz en ligne. Ce projet comprend une API, un client web et une application mobile.

Prérequis

Vous pouvez installer yarn, même sur les pcs de prêt, si votre version de Node est 20 ou plus. Pour cela corepack enable puis exécuter l'une des commandes de l'application yarn qqch, node vous proposera d'installer.

Installation

1. Clonez le dépôt :

   git clone https://gitlab.com/your-repo/kwizos.git
   cd the-sevens

2. Installez les dépendances pour chaque dossier (QuizzMobile, QuizzWeb, ZmeiDB) :

   cd QuizzWeb
   yarn install
   cd ../QuizzMobile
   yarn install
   cd ../ZmeiDB
   yarn install

Démarrage rapide

Téléchargez d'abord la version stable la plus récente depuis la branche Releases. Rendez-vous dans le dossier du projet 'the-sevens'.

Pour démarrer la solution, ouvrez chacun des dossiers (QuizzMobile, QuizzWeb, ZmeiDB) dans votre terminal. Puis exécutez, de préférence dans cet ordre :

Pour l'API et le client web :

yarn install
yarn start
docker-compose up --build -d

Pour l'API, vérifiez qu'elle fonctionne sur http://localhost:5173

Pour voir le client web, rendez-vous sur http://localhost:5173

Pour le mobile :

yarn run start

Connectez-vous avec Expo Go via le QR code.

Utilisation

Après avoir démarré les services, vous pouvez accéder à l'application web à l'adresse http://localhost:5173 et utiliser l'application mobile via Expo Go.

Tests

Pour exécuter les tests, utilisez la commande suivante dans chaque dossier :

yarn test

Releases, versions v0, 1, ...

Les versions à rendre sont taggées sur GitLab. Si plusieurs sont taggées version 1.x (par exemple), regardez la plus récente.

Contribuer

Les contributions sont les bienvenues ! Pour contribuer, veuillez suivre ces étapes :

1. Forkez le dépôt.
2. Demandez l'accès au Jira du groupe via gitlab.
3. Regarder les convention dans le confluence "Workflow".

Contacts

Pour toutes informations supplémentaires, voir le Confluence de l'équipe https://glazk.atlassian.net/jira/software/projects/KWIZOS/boards/1

Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.