Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 2.92 KB

README.md

File metadata and controls

67 lines (49 loc) · 2.92 KB

Logo

Comus Party

Application de mini-jeux en ligne

Test
Pull Request Stars Qualité de Code


Informations

Comus Party est une application de mini-jeux en ligne, elle est développée dans le cadre de la SAE 3.01 du BUT Informatique à l'IUT de Bayonne et du Pays Basque.

Fonctionnalités

  • Interface pour chaque type d'utilisateur
  • Mode sombre/clair
  • Boutique de cosmétiques
  • Gestion des parties
  • Système de suggestion in-app
  • Classement
  • Personnalisation du profil joueur
  • Modularité des jeux

Interface

Informations techniques

Comus Party fonctionne avec Tailwind CSS pour l'interface ainsi que Twig en tant que framework. Les fichiers du site sont donc des fichiers twig (fichier.twig) et le reste en PHP (fichier.php).
Le projet comporte aussi des fichiers JavaScript pour les fonctionnalités dynamiques.

Le projet suit le modèle MVC (Modèle-Vue-Contrôleur) qui garantit une séparation claire des responsabilités, avec une couche Modèle (Models) gérant les données, une couche Vue (templates) pour l'interface utilisateur, et une couche Contrôleur (Controllers) assurant la coordination entre les deux. Cette organisation facilite la maintenance et l'évolution du code tout en respectant les bonnes pratiques de développement.

Vous pouvez consulter la documentation technique sur notre site.

Développer

Afin de développer sur Comus Party, il vous faudra suivre les étapes ci-dessous :

  1. Cloner le projet
git clone https://github.com/ValbionGroup/Comus-Party.git
  1. Copier le fichier .env.example puis renomer-le en .env et modifier les informations de connexion à la base de données ainsi que les autres informations nécessaires.

  2. Créer la base de données et les tables nécessaires en respectant le schéma de la base de données. Vous pouvez utiliser le fichier comusparty_export.sql pour cela.

Warning

Ce fichier insère des données, il est donc préférable de le modifier pour qu'il n'insère pas de données si vous souhaitez avoir une base de données vide.

  1. Ensuite faites les commandes ci-dessous afin d'initialiser le projet :
composer install
npm install
npm run build # Si en production
npm run watch # Si en développement